@types/json2csv/index.d.ts

TypeScript definitions for json2csv

/// <reference types="node" />
import { Readable, TransformOptions } from "stream";

import JSON2CSVParser = require("./JSON2CSVParser");
import JSON2CSVAsyncParser = require("./JSON2CSVAsyncParser");
import JSON2CSVTransform = require("./JSON2CSVTransform");
import flatten = require("./transforms/flatten");
import unwind = require("./transforms/unwind");

export as namespace json2csv;

export { JSON2CSVAsyncParser as AsyncParser, JSON2CSVParser as Parser, JSON2CSVTransform as Transform };

// Convenience method to keep the API similar to version 3.X
export function parse<T>(data: Readonly<T> | readonly T[], opts?: json2csv.Options<T>): string;

export function parseAsync<T>(
    data: Readonly<T> | readonly T[] | Readable,
    opts?: json2csv.Options<T>,
    transformOpts?: TransformOptions,
): Promise<string>;

export const transforms: {
    flatten: typeof flatten;
    unwind: typeof unwind;
};

export interface FieldValueCallbackInfo {
    label: string;
    default?: string | undefined;
}

export type FieldValueCallback<T> = FieldValueCallbackWithoutField<T> | FieldValueCallbackWithField<T>;

export interface FieldValueCallbackWithoutField<T> {
    (row: T): any;
}

export interface FieldValueCallbackWithField<T> {
    (row: T, field: FieldValueCallbackInfo): any;
}

export interface FieldInfo<T> {
    label?: string | undefined;
    default?: string | undefined;
    value: string | FieldValueCallback<T>;
}

export interface NormalizedFieldInfo<T> {
    label: string;
    value: FieldValueCallback<T>;
}

export interface Options<T> {
    fields?: Array<string | FieldInfo<T>> | undefined;
    ndjson?: boolean | undefined;
    defaultValue?: string | undefined;
    quote?: string | undefined;
    escapedQuote?: string | undefined;
    delimiter?: string | undefined;
    eol?: string | undefined;
    excelStrings?: boolean | undefined;
    header?: boolean | undefined;
    includeEmptyRows?: boolean | undefined;
    withBOM?: boolean | undefined;
    transforms?: Array<Json2CsvTransform<any, any>> | undefined;
}

export interface FlattenOptions {
    objects?: boolean | undefined;
    arrays?: boolean | undefined;
    separator?: string | undefined;
}

export type Json2CsvTransform<T1, T2> = (item: T1) => T2 | T2[];

export interface UnwindOptions {
    paths?: string[] | undefined;
    blankOut?: boolean | undefined;
}