mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2026-10-03 22:37:03 +00:00
papaparse: expose types from module (#22155)
This commit is contained in:
John Reilly
Vendored
+107
-119
@@ -3,146 +3,134 @@
|
||||
// Definitions by: Pedro Flemming <https://github.com/torpedro>
|
||||
// Rain Shen <https://github.com/rainshen49>
|
||||
// João Loff <https://github.com/jfloff>
|
||||
// John Reilly <https://github.com/johnnyreilly>
|
||||
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
||||
|
||||
declare namespace PapaParse {
|
||||
interface Static {
|
||||
/**
|
||||
* Parse a csv string or a csv file
|
||||
*/
|
||||
parse(csvString: string, config?: ParseConfig): ParseResult;
|
||||
export as namespace Papa;
|
||||
|
||||
parse(file: File, config?: ParseConfig): ParseResult;
|
||||
/**
|
||||
* Parse a csv string or a csv file
|
||||
*/
|
||||
export function parse(csvString: string, config?: ParseConfig): ParseResult;
|
||||
|
||||
/**
|
||||
* Unparses javascript data objects and returns a csv string
|
||||
*/
|
||||
unparse(data: Array<Object>, config?: UnparseConfig): string;
|
||||
export function parse(file: File, config?: ParseConfig): ParseResult;
|
||||
|
||||
unparse(data: Array<Array<any>>, config?: UnparseConfig): string;
|
||||
/**
|
||||
* Unparses javascript data objects and returns a csv string
|
||||
*/
|
||||
export function unparse(data: Array<Object>, config?: UnparseConfig): string;
|
||||
|
||||
unparse(data: UnparseObject, config?: UnparseConfig): string;
|
||||
export function unparse(data: Array<Array<any>>, config?: UnparseConfig): string;
|
||||
|
||||
/**
|
||||
* Read-Only Properties
|
||||
*/
|
||||
// An array of characters that are not allowed as delimiters.
|
||||
BAD_DELIMETERS: Array<string>;
|
||||
export function unparse(data: UnparseObject, config?: UnparseConfig): string;
|
||||
|
||||
// The true delimiter. Invisible. ASCII code 30. Should be doing the job we strangely rely upon commas and tabs for.
|
||||
RECORD_SEP: string;
|
||||
/**
|
||||
* Read-Only Properties
|
||||
*/
|
||||
// An array of characters that are not allowed as delimiters.
|
||||
export const BAD_DELIMETERS: Array<string>;
|
||||
|
||||
// Also sometimes used as a delimiting character. ASCII code 31.
|
||||
UNIT_SEP: string;
|
||||
// The true delimiter. Invisible. ASCII code 30. Should be doing the job we strangely rely upon commas and tabs for.
|
||||
export const RECORD_SEP: string;
|
||||
|
||||
// Whether or not the browser supports HTML5 Web Workers. If false, worker: true will have no effect.
|
||||
WORKERS_SUPPORTED: boolean;
|
||||
// Also sometimes used as a delimiting character. ASCII code 31.
|
||||
export const UNIT_SEP: string;
|
||||
|
||||
// The relative path to Papa Parse. This is automatically detected when Papa Parse is loaded synchronously.
|
||||
SCRIPT_PATH: string;
|
||||
// Whether or not the browser supports HTML5 Web Workers. If false, worker: true will have no effect.
|
||||
export const WORKERS_SUPPORTED: boolean;
|
||||
|
||||
/**
|
||||
* Configurable Properties
|
||||
*/
|
||||
// The size in bytes of each file chunk. Used when streaming files obtained from the DOM that exist on the local computer. Default 10 MB.
|
||||
LocalChunkSize: string;
|
||||
// The relative path to Papa Parse. This is automatically detected when Papa Parse is loaded synchronously.
|
||||
export const SCRIPT_PATH: string;
|
||||
|
||||
// Same as LocalChunkSize, but for downloading files from remote locations. Default 5 MB.
|
||||
RemoteChunkSize: string;
|
||||
/**
|
||||
* Configurable Properties
|
||||
*/
|
||||
// The size in bytes of each file chunk. Used when streaming files obtained from the DOM that exist on the local computer. Default 10 MB.
|
||||
export let LocalChunkSize: string;
|
||||
|
||||
// The delimiter used when it is left unspecified and cannot be detected automatically. Default is comma.
|
||||
DefaultDelimiter: string;
|
||||
// Same as LocalChunkSize, but for downloading files from remote locations. Default 5 MB.
|
||||
export let RemoteChunkSize: string;
|
||||
|
||||
/**
|
||||
* On Papa there are actually more classes exposed
|
||||
* but none of them are officially documented
|
||||
* Since we can interact with the Parser from one of the callbacks
|
||||
* I have included the API for this class.
|
||||
*/
|
||||
Parser: ParserConstructor;
|
||||
}
|
||||
// The delimiter used when it is left unspecified and cannot be detected automatically. Default is comma.
|
||||
export let DefaultDelimiter: string;
|
||||
|
||||
interface ParseConfig {
|
||||
delimiter?: string; // default: ""
|
||||
newline?: string; // default: ""
|
||||
quoteChar?: string; // default: '"'
|
||||
header?: boolean; // default: false
|
||||
dynamicTyping?: boolean; // default: false
|
||||
preview?: number; // default: 0
|
||||
encoding?: string; // default: ""
|
||||
worker?: boolean; // default: false
|
||||
comments?: boolean | string; // default: false
|
||||
download?: boolean; // default: false
|
||||
skipEmptyLines?: boolean; // default: false
|
||||
fastMode?: boolean; // default: undefined
|
||||
withCredentials?: boolean; // default: undefined
|
||||
/**
|
||||
* On Papa there are actually more classes exposed
|
||||
* but none of them are officially documented
|
||||
* Since we can interact with the Parser from one of the callbacks
|
||||
* I have included the API for this class.
|
||||
*/
|
||||
export class Parser {
|
||||
|
||||
// Callbacks
|
||||
step?(results: ParseResult, parser: Parser): void; // default: undefined
|
||||
complete?(results: ParseResult, file?: File): void; // default: undefined
|
||||
error?(error: ParseError, file?: File): void; // default: undefined
|
||||
chunk?(results: ParseResult, parser: Parser): void; // default: undefined
|
||||
beforeFirstChunk?(chunk: string): string | void; // default: undefined
|
||||
}
|
||||
constructor(config: ParseConfig);
|
||||
|
||||
interface UnparseConfig {
|
||||
quotes?: boolean; // default: false
|
||||
delimiter?: string; // default: ","
|
||||
newline?: string; // default: "\r\n"
|
||||
}
|
||||
parse(input: string, baseIndex: number, ignoreLastRow: boolean): any;
|
||||
|
||||
interface UnparseObject {
|
||||
fields: Array<any>;
|
||||
data: string | Array<any>;
|
||||
}
|
||||
// Sets the abort flag
|
||||
abort(): void;
|
||||
|
||||
interface ParseError {
|
||||
type: string; // A generalization of the error
|
||||
code: string; // Standardized error code
|
||||
message: string; // Human-readable details
|
||||
row: number; // Row index of parsed data where error is
|
||||
}
|
||||
|
||||
interface ParseMeta {
|
||||
delimiter: string; // Delimiter used
|
||||
linebreak: string; // Line break sequence used
|
||||
aborted: boolean; // Whether process was aborted
|
||||
fields: Array<string>; // Array of field names
|
||||
truncated: boolean; // Whether preview consumed all input
|
||||
}
|
||||
|
||||
/**
|
||||
* @interface ParseResult
|
||||
*
|
||||
* data: is an array of rows. If header is false, rows are arrays; otherwise they are objects of data keyed by the field name.
|
||||
* errors: is an array of errors
|
||||
* meta: contains extra information about the parse, such as delimiter used, the newline sequence, whether the process was aborted, etc. Properties in this object are not guaranteed to exist in all situations
|
||||
*/
|
||||
interface ParseResult {
|
||||
data: Array<any>;
|
||||
errors: Array<ParseError>;
|
||||
meta: ParseMeta;
|
||||
}
|
||||
|
||||
/**
|
||||
* Parser
|
||||
*/
|
||||
interface ParserConstructor { new (config: ParseConfig): Parser; }
|
||||
interface Parser {
|
||||
// Parses the input
|
||||
parse(input: string, baseIndex: number, ignoreLastRow: boolean): any;
|
||||
|
||||
// Sets the abort flag
|
||||
abort(): void;
|
||||
|
||||
// Gets the cursor position
|
||||
getCharIndex(): number;
|
||||
}
|
||||
// Gets the cursor position
|
||||
getCharIndex(): number;
|
||||
}
|
||||
|
||||
declare var Papa: PapaParse.Static;
|
||||
export interface ParseConfig {
|
||||
delimiter?: string; // default: ""
|
||||
newline?: string; // default: ""
|
||||
quoteChar?: string; // default: '"'
|
||||
header?: boolean; // default: false
|
||||
dynamicTyping?: boolean; // default: false
|
||||
preview?: number; // default: 0
|
||||
encoding?: string; // default: ""
|
||||
worker?: boolean; // default: false
|
||||
comments?: boolean | string; // default: false
|
||||
download?: boolean; // default: false
|
||||
skipEmptyLines?: boolean; // default: false
|
||||
fastMode?: boolean; // default: undefined
|
||||
withCredentials?: boolean; // default: undefined
|
||||
|
||||
declare module "papaparse" {
|
||||
var Papa: PapaParse.Static;
|
||||
export = Papa;
|
||||
// Callbacks
|
||||
step?(results: ParseResult, parser: Parser): void; // default: undefined
|
||||
complete?(results: ParseResult, file?: File): void; // default: undefined
|
||||
error?(error: ParseError, file?: File): void; // default: undefined
|
||||
chunk?(results: ParseResult, parser: Parser): void; // default: undefined
|
||||
beforeFirstChunk?(chunk: string): string | void; // default: undefined
|
||||
}
|
||||
|
||||
export interface UnparseConfig {
|
||||
quotes?: boolean; // default: false
|
||||
delimiter?: string; // default: ","
|
||||
newline?: string; // default: "\r\n"
|
||||
}
|
||||
|
||||
export interface UnparseObject {
|
||||
fields: Array<any>;
|
||||
data: string | Array<any>;
|
||||
}
|
||||
|
||||
export interface ParseError {
|
||||
type: string; // A generalization of the error
|
||||
code: string; // Standardized error code
|
||||
message: string; // Human-readable details
|
||||
row: number; // Row index of parsed data where error is
|
||||
}
|
||||
|
||||
export interface ParseMeta {
|
||||
delimiter: string; // Delimiter used
|
||||
linebreak: string; // Line break sequence used
|
||||
aborted: boolean; // Whether process was aborted
|
||||
fields: Array<string>; // Array of field names
|
||||
truncated: boolean; // Whether preview consumed all input
|
||||
}
|
||||
|
||||
/**
|
||||
* @interface ParseResult
|
||||
*
|
||||
* data: is an array of rows. If header is false, rows are arrays; otherwise they are objects of data keyed by the field name.
|
||||
* errors: is an array of errors
|
||||
* meta: contains extra information about the parse, such as delimiter used, the newline sequence, whether the process was aborted, etc. Properties in this object are not guaranteed to exist in all situations
|
||||
*/
|
||||
export interface ParseResult {
|
||||
data: Array<any>;
|
||||
errors: Array<ParseError>;
|
||||
meta: ParseMeta;
|
||||
}
|
||||
|
||||
@@ -1,6 +1,14 @@
|
||||
|
||||
|
||||
import Papa = require("papaparse");
|
||||
import {
|
||||
ParseConfig,
|
||||
UnparseConfig,
|
||||
UnparseObject,
|
||||
ParseError,
|
||||
ParseMeta,
|
||||
ParseResult
|
||||
} from "papaparse";
|
||||
|
||||
/**
|
||||
* Parsing
|
||||
|
||||
Reference in New Issue
Block a user