Logo for jsDocs.io

csv-string

  • Version 4.1.1
  • Published
  • 30.3 kB
  • No dependencies
  • MIT license

Install

npm i csv-string
yarn add csv-string
pnpm add csv-string

Overview

PARSE and STRINGIFY for CSV strings. It's like JSON object but for CSV. It can also work row by row. And, if can parse strings, it can be use to parse files or streams too.

Index

Variables

Functions

Variables

variable eol

const eol: LineBreak;

    variable separator

    const separator: Comma;

      Functions

      function createStream

      createStream: (
          options?:
              | {
                    separator?: ',' | ';' | '|' | '\t' | undefined;
                    quote?: string | undefined;
                }
              | undefined
      ) => Streamer;

        function detect

        detect: (input: string) => Comma;

          function fetch

          fetch: (
              input: string,
              sep?: ',' | ';' | '|' | '\t' | undefined,
              quo?: string | undefined
          ) => string[];

            function forEach

            forEach: {
                (input: string, callback: ForEachCallback): void;
                (input: string, sep: Comma, callback: ForEachCallback): void;
                (input: string, sep: Comma, quo: string, callback: ForEachCallback): void;
            };

              function parse

              parse: {
                  (input: string, sep?: Comma, quo?: Quote): Value[][];
                  (input: string, opts?: Partial<ParseOptions & { output: 'tuples' }>): string[][];
                  (input: string, opts: Partial<ParseOptions> & { output: 'objects' }): {
                      [k: string]: string;
                  }[];
              };

                function read

                read: {
                    (input: string, callback: ReadCallback): number;
                    (input: string, sep: Comma, callback: ReadCallback): number;
                    (input: string, sep: Comma, quo: string, callback: ReadCallback): number;
                };

                  function readAll

                  readAll: {
                      (input: string, callback: ReadAllCallback): number;
                      (input: string, sep: Comma, callback: ReadAllCallback): number;
                      (input: string, sep: Comma, quo: string, callback: ReadAllCallback): number;
                  };

                    function readChunk

                    readChunk: {
                        (input: string, callback: ReadAllCallback): number;
                        (input: string, sep: Comma, callback: ReadAllCallback): number;
                        (input: string, sep: Comma, quo: string, callback: ReadAllCallback): number;
                    };

                      function stringify

                      stringify: (input?: PristineInput, sep?: Comma) => string;

                        Package Files (2)

                        Dependencies (0)

                        No dependencies.

                        Dev Dependencies (14)

                        Peer Dependencies (0)

                        No peer dependencies.

                        Badge

                        To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                        You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/csv-string.

                        • Markdown
                          [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/csv-string)
                        • HTML
                          <a href="https://www.jsdocs.io/package/csv-string"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>