Export

CSVFormatter

export type CSVFormatter = (
  options: Partial<CSVFormat>,
  data: DataInput,
) => string;

---

ExportCsv

class ExportCsv {
  doExport({ data, headers, props }: DataInput): string;
}

---

ExportFormat

export type ExportFormat = Partial<CSVFormat>;

---

ExportFilePlugin

class ExportFilePlugin {
  /** Exports string */
  exportString(options?: ExportFormat, t?: ExportTypes): Promise<string | null>;

  /** Exports Blob */
  exportBlob(options?: ExportFormat, t?: ExportTypes): Promise<Blob | null>;

  /** Export file */
  exportFile(options?: ExportFormat, t?: ExportTypes): Promise<void>;

  /** Blob object */
  getBlob(formatter: Formatter): Promise<Blob | null>;
}

---

ColSource

export type ColSource = {
  headers: string[][];
  props: any[];
};

---

DataInput (Extended from export.plugin.d.ts)

export type DataInput = {
  data: DataType[];
} & ColSource;

---

FormatterOptions

interface FormatterOptions {
  mime: string;
  encoding: string;
}

---

Formatter

interface Formatter {
  options: FormatterOptions;
  doExport(data: DataInput): string;
}

---

CSVFormat (Extended from export.plugin.d.ts)

interface CSVFormat {
  fileKind: 'csv';
  bom: boolean;
  columnDelimiter: string;
  rowDelimiter: string;
  filename?: string;
}