A11 TypeScript API - v0.7.26
    Preparing search index...

    Interface NodeBinding

    Worker operations used by the typed node convenience.

    interface NodeBinding {
        id: string;
        abortWithStatus(status: Status): Promise<unknown>;
        cancel(): Promise<unknown>;
        cancelReader(): Promise<unknown>;
        cancelWriter(): Promise<unknown>;
        close(): Promise<unknown>;
        finalize(
            value?: {
                chunk?: Record<string, unknown>;
                close?: boolean;
                reference?: Record<string, unknown>;
                sequence?: number;
                wait?: boolean;
            },
        ): Promise<unknown>;
        isWritable(): Promise<boolean>;
        nextChunk(
            options?: { signal?: AbortSignal; timeoutMs?: number },
        ): Promise<Record<string, unknown> | null>;
        nextFragment(
            options?: { signal?: AbortSignal; timeoutMs?: number },
        ): Promise<Record<string, unknown> | null>;
        putChunk(
            chunk: Record<string, unknown>,
            options?: { final?: boolean; sequence?: number },
        ): Promise<{ sequence: number }>;
        putFragment(
            fragment: Record<string, unknown>,
        ): Promise<{ sequence: number }>;
        readerOptions(): Promise<ChunkStoreReaderOptions>;
        ready(): Promise<unknown>;
        ref(
            options?: {
                length?: number | null;
                offset?: number;
                storage?: "auto" | "include" | "omit";
            },
        ): Promise<Record<string, unknown>>;
        resetReader(options?: ChunkStoreReaderOptions): Promise<unknown>;
        setReaderOptions(options: ChunkStoreReaderOptions): Promise<unknown>;
        setWriterOptions(options: ChunkStoreWriterOptions): Promise<unknown>;
        state(): Promise<
            {
                readerStatus: Status;
                writerAbortStatus: Status
                | null;
                writerStatus: Status;
            },
        >;
        waitForBufferToDrain(options?: { timeoutMs?: number }): Promise<unknown>;
        writerOptions(): Promise<ChunkStoreWriterOptions>;
    }
    Index
    id: string
    • Parameters

      • Optionalvalue: {
            chunk?: Record<string, unknown>;
            close?: boolean;
            reference?: Record<string, unknown>;
            sequence?: number;
            wait?: boolean;
        }

      Returns Promise<unknown>

    • Parameters

      • Optionaloptions: { signal?: AbortSignal; timeoutMs?: number }

      Returns Promise<Record<string, unknown> | null>

    • Parameters

      • Optionaloptions: { signal?: AbortSignal; timeoutMs?: number }

      Returns Promise<Record<string, unknown> | null>

    • Parameters

      • chunk: Record<string, unknown>
      • Optionaloptions: { final?: boolean; sequence?: number }

      Returns Promise<{ sequence: number }>

    • Parameters

      • fragment: Record<string, unknown>

      Returns Promise<{ sequence: number }>

    • Parameters

      • Optionaloptions: {
            length?: number | null;
            offset?: number;
            storage?: "auto" | "include" | "omit";
        }

      Returns Promise<Record<string, unknown>>

    • Returns Promise<
          {
              readerStatus: Status;
              writerAbortStatus: Status
              | null;
              writerStatus: Status;
          },
      >

    • Parameters

      • Optionaloptions: { timeoutMs?: number }

      Returns Promise<unknown>