web-csv-toolbox 0.7.5 → 0.8.0

package/dist/types/assertCommonOptions.d.ts

@@ -1,7 +1,20 @@
 import type { CommonOptions } from "./common/types.ts";
 /**
- * Assert that the options are valid.
+ * Asserts that the provided options object contains all the required properties.
+ * Throws an error if any required property is missing
+ * or if the delimiter and quotation length is not 1 byte character,
+ * or if the delimiter is the same as the quotation.
  *
- * @param options The options to assert.
+ * @example
+ *
+ * ```ts
+ * assertCommonOptions({
+ *   quotation: '"',
+ *   delimiter: ',',
+ * });
+ * ```
+ *
+ * @param options - The options object to be validated.
+ * @throws {Error} If any required property is missing or if the delimiter is the same as the quotation.
  */
-export declare function assertCommonOptions(options: Required<CommonOptions>): void;
+export declare function assertCommonOptions(options: Required<CommonOptions>): asserts options is Required<CommonOptions>;

package/dist/types/common/types.d.ts

@@ -20,20 +20,23 @@ export type Token = FieldToken | typeof FieldDelimiter | typeof RecordDelimiter;
 export interface CommonOptions {
     /**
      * CSV field delimiter.
+     * If you want to parse TSV, specify `'\t'`.
      *
      * @remarks
-     * If you want to parse TSV, specify `'\t'`.
+     * Detail restrictions are as follows:
+     *
+     * - Must not be empty
+     * - Must be a single character
+     *    - Multi-byte characters are not supported
+     * - Must not include CR or LF
+     * - Must not be the same as the quotation
      *
-     * This library supports multi-character delimiters.
      * @default ','
      */
     delimiter?: string;
     /**
      * CSV field quotation.
      *
-     * @remarks
-     * This library supports multi-character quotations.
-     *
      * @default '"'
      */
     quotation?: string;