fastyaml-rs 0.1.4 → 0.1.6

package/index.d.ts

@@ -1,126 +1,172 @@
-/**
- * Fast YAML 1.2.2 parser for Node.js, powered by Rust
- *
- * This module provides high-performance YAML parsing and serialization
- * with 5-10x speedup over pure JavaScript implementations.
- *
- * @module @fast-yaml/core
- */
-
-/**
- * Options for YAML serialization.
- */
+/* auto-generated by NAPI-RS */
+/* eslint-disable */
+/** Options for YAML serialization. */
 export interface DumpOptions {
+  /** If true, sort object keys alphabetically (default: false) */
+  sortKeys?: boolean
   /**
-   * If true, sort object keys alphabetically (default: false)
-   */
-  sortKeys?: boolean;
-
-  /**
-   * Allow unicode characters (default: true)
-   * Note: yaml-rust2 always outputs unicode; this is accepted for API compatibility
+   * Allow unicode characters (default: true).
+   * Note: yaml-rust2 always outputs unicode; this is accepted for API compatibility.
    */
-  allowUnicode?: boolean;
+  allowUnicode?: boolean
 }
 
 /**
- * Parse a YAML string and return a JavaScript object.
- * Equivalent to js-yaml's `safeLoad()`.
+ * Serialize a JavaScript object to a YAML string.
  *
- * @param yamlStr - YAML string to parse
- * @returns Parsed JavaScript object
- * @throws {Error} If YAML is invalid or exceeds 100MB limit
+ * This is equivalent to js-yaml's `safeDump()` and `PyYAML`'s `safe_dump()`.
  *
- * @example
- * ```typescript
- * import { safeLoad } from '@fast-yaml/core';
+ * # Arguments
  *
- * const data = safeLoad('name: test\nvalue: 123');
- * console.log(data); // { name: 'test', value: 123 }
+ * * `data` - A JavaScript object to serialize (Object, Array, string, number, boolean, null)
+ * * `options` - Optional serialization options
+ *
+ * # Returns
+ *
+ * A YAML string representation of the object
+ *
+ * # Errors
+ *
+ * Throws an error if the object contains non-serializable types.
+ *
+ * # Example
+ *
+ * ```javascript
+ * const { safeDump } = require('@fast-yaml/core');
+ *
+ * const yaml = safeDump({ name: 'test', value: 123 });
+ * console.log(yaml); // 'name: test
+value: 123
+'
  * ```
  */
-export function safeLoad(yamlStr: string): unknown;
+export declare function safeDump(data: unknown, options?: DumpOptions | undefined | null): NapiResult<string>
 
 /**
- * Parse a YAML string containing multiple documents.
- * Equivalent to js-yaml's `safeLoadAll()`.
+ * Serialize multiple JavaScript objects to a YAML string with document separators.
  *
- * @param yamlStr - YAML string potentially containing multiple documents
- * @returns Array of parsed JavaScript objects
- * @throws {Error} If YAML is invalid or exceeds 100MB limit
+ * This is equivalent to js-yaml's `safeDumpAll()` and `PyYAML`'s `safe_dump_all()`.
  *
- * @example
- * ```typescript
- * import { safeLoadAll } from '@fast-yaml/core';
+ * # Arguments
  *
- * const docs = safeLoadAll('---\nfoo: 1\n---\nbar: 2');
- * console.log(docs); // [{ foo: 1 }, { bar: 2 }]
+ * * `documents` - An array of JavaScript objects to serialize
+ * * `options` - Optional serialization options
+ *
+ * # Returns
+ *
+ * A YAML string with multiple documents separated by "---"
+ *
+ * # Errors
+ *
+ * Throws an error if:
+ * - Any object cannot be serialized
+ * - Total output size exceeds 100MB limit
+ *
+ * # Security
+ *
+ * Maximum output size is limited to 100MB to prevent memory exhaustion.
+ *
+ * # Example
+ *
+ * ```javascript
+ * const { safeDumpAll } = require('@fast-yaml/core');
+ *
+ * const yaml = safeDumpAll([{ a: 1 }, { b: 2 }]);
+ * console.log(yaml); // '---
+a: 1
+---
+b: 2
+'
  * ```
  */
-export function safeLoadAll(yamlStr: string): unknown[];
+export declare function safeDumpAll(documents: Array<unknown>, options?: DumpOptions | undefined | null): NapiResult<string>
 
 /**
- * Serialize a JavaScript object to YAML string.
- * Equivalent to js-yaml's `safeDump()`.
+ * Parse a YAML string and return a JavaScript object.
  *
- * @param data - JavaScript object to serialize
- * @param options - Serialization options
- * @returns YAML string representation
- * @throws {TypeError} If object contains non-serializable types
+ * This is equivalent to js-yaml's `safeLoad()` and `PyYAML`'s `safe_load()`.
  *
- * @example
- * ```typescript
- * import { safeDump } from '@fast-yaml/core';
+ * # Arguments
  *
- * const yaml = safeDump({ name: 'test', value: 123 });
- * console.log(yaml); // 'name: test\nvalue: 123\n'
+ * * `yaml_str` - A YAML document as a string
+ *
+ * # Returns
+ *
+ * The parsed YAML document as JavaScript objects (Object, Array, string, number, boolean, null)
+ *
+ * # Errors
+ *
+ * Throws an error if:
+ * - The YAML is invalid
+ * - Input exceeds size limit (100MB)
+ *
+ * # Security
+ *
+ * Maximum input size is limited to 100MB to prevent denial-of-service attacks.
+ *
+ * # Example
+ *
+ * ```javascript
+ * const { safeLoad } = require('@fast-yaml/core');
+ *
+ * const data = safeLoad('name: test
+value: 123');
+ * console.log(data); // { name: 'test', value: 123 }
  * ```
  */
-export function safeDump(data: unknown, options?: DumpOptions): string;
+export declare function safeLoad(yamlStr: string): NapiResult<unknown>
 
 /**
- * Serialize multiple JavaScript objects to YAML with document separators.
- * Equivalent to js-yaml's `safeDumpAll()`.
+ * Parse a YAML string containing multiple documents.
  *
- * @param documents - Array of JavaScript objects to serialize
- * @param options - Serialization options
- * @returns YAML string with '---' separators
- * @throws {TypeError} If any object cannot be serialized
- * @throws {Error} If output exceeds 100MB limit
+ * This is equivalent to js-yaml's `safeLoadAll()` and `PyYAML`'s `safe_load_all()`.
  *
- * @example
- * ```typescript
- * import { safeDumpAll } from '@fast-yaml/core';
+ * # Arguments
  *
- * const yaml = safeDumpAll([{ a: 1 }, { b: 2 }]);
- * console.log(yaml); // '---\na: 1\n---\nb: 2\n'
+ * * `yaml_str` - A YAML string potentially containing multiple documents
+ *
+ * # Returns
+ *
+ * An array of parsed JavaScript objects
+ *
+ * # Errors
+ *
+ * Throws an error if:
+ * - The YAML is invalid
+ * - Input exceeds size limit (100MB)
+ *
+ * # Security
+ *
+ * Maximum input size is limited to 100MB to prevent denial-of-service attacks.
+ *
+ * # Example
+ *
+ * ```javascript
+ * const { safeLoadAll } = require('@fast-yaml/core');
+ *
+ * const docs = safeLoadAll('---
+foo: 1
+---
+bar: 2');
+ * console.log(docs); // [{ foo: 1 }, { bar: 2 }]
  * ```
  */
-export function safeDumpAll(documents: unknown[], options?: DumpOptions): string;
+export declare function safeLoadAll(yamlStr: string): NapiResult<Array<unknown>>
 
 /**
  * Get the library version.
  *
- * @returns Version string (e.g., "0.1.0")
+ * Returns the version string of the fast-yaml-nodejs crate.
  *
- * @example
- * ```typescript
- * import { version } from '@fast-yaml/core';
+ * # Examples
  *
+ * ```javascript
+ * const { version } = require('@fast-yaml/core');
  * console.log(version()); // "0.1.0"
  * ```
  */
-export function version(): string;
+export declare function version(): string
 
 // Aliases for js-yaml compatibility
-/**
- * Alias for safeLoad() for js-yaml compatibility.
- * @deprecated Use safeLoad() instead
- */
-export { safeLoad as load };
-
-/**
- * Alias for safeDump() for js-yaml compatibility.
- * @deprecated Use safeDump() instead
- */
-export { safeDump as dump };
+export declare const load: typeof safeLoad
+export declare const dump: typeof safeDump