web-csv-toolbox - v0.15.0
    Preparing search index...

    Function createStringCSVLexer

    • Factory function to create a string CSV lexer instance.

      Type Parameters

      • Delimiter extends string = ","
      • Quotation extends string = "\""
      • TrackLocation extends boolean = false

      Parameters

      Returns StringCSVLexer<TrackLocation>

      A FlexibleStringCSVLexer instance configured with the specified options

      Design Intent: This factory function accepts options including engine configuration to enable future execution path optimization. The function may select the optimal internal lexer implementation based on the provided options. Currently, this optimization is not implemented, but the API is designed to support it without breaking changes.

      // Create a lexer with default options
      const lexer = createStringCSVLexer();

      // Create a lexer with custom delimiter
      const tsvLexer = createStringCSVLexer({
      delimiter: '\t'
      });

      // Create a lexer with abort signal
      const controller = new AbortController();
      const lexer = createStringCSVLexer({
      signal: controller.signal
      });