fast-fs-hash - v0.0.0-rc4
    Preparing search index...

    Interface IXxHash128Functions

    Stateless xxHash128 digest functions — available as static methods on XxHash128Stream.

    interface IXxHash128Functions {
        digestBuffer(input: Uint8Array): Buffer;
        digestBufferRange(
            input: Uint8Array,
            offset: number,
            length?: number,
        ): Buffer;
        digestBufferRangeTo<
            TOut extends Uint8Array<ArrayBufferLike> = Buffer<ArrayBufferLike>,
        >(
            input: Uint8Array,
            offset: number,
            length: number,
            out: TOut,
            outOffset?: number,
        ): TOut;
        digestBufferTo<
            TOut extends Uint8Array<ArrayBufferLike> = Buffer<ArrayBufferLike>,
        >(
            input: Uint8Array,
            out: TOut,
            outOffset?: number,
        ): TOut;
        digestFile(
            path: string,
            throwOnError?: boolean,
        ): Promise<Buffer<ArrayBufferLike>>;
        digestFilesParallel(
            paths: readonly string[],
            concurrency?: number,
            throwOnError?: boolean,
        ): Promise<Buffer<ArrayBufferLike>>;
        digestFilesParallelTo<TOut extends Uint8Array<ArrayBufferLike>>(
            paths: readonly string[],
            out: TOut,
            outOffset?: number,
            concurrency?: number,
            throwOnError?: boolean,
        ): Promise<TOut>;
        digestFilesSequential(
            paths: readonly string[],
            throwOnError?: boolean,
        ): Promise<Buffer<ArrayBufferLike>>;
        digestFilesSequentialTo<TOut extends Uint8Array<ArrayBufferLike>>(
            paths: readonly string[],
            out: TOut,
            outOffset?: number,
            throwOnError?: boolean,
        ): Promise<TOut>;
        digestFileTo<
            TOut extends Uint8Array<ArrayBufferLike> = Buffer<ArrayBufferLike>,
        >(
            path: string,
            out: TOut,
            outOffset?: number,
            throwOnError?: boolean,
        ): Promise<TOut>;
        digestString(input: string): Buffer;
        digestStringTo<
            TOut extends Uint8Array<ArrayBufferLike> = Buffer<ArrayBufferLike>,
        >(
            input: string,
            out: TOut,
            outOffset?: number,
        ): TOut;
    }
    Index

    Methods

    • Parameters

      • input: Uint8Array

      Returns Buffer

    • Parameters

      • input: Uint8Array
      • offset: number
      • Optionallength: number

      Returns Buffer

    • Type Parameters

      • TOut extends Uint8Array<ArrayBufferLike> = Buffer<ArrayBufferLike>

      Parameters

      • input: Uint8Array
      • offset: number
      • length: number
      • out: TOut
      • OptionaloutOffset: number

      Returns TOut

    • Type Parameters

      • TOut extends Uint8Array<ArrayBufferLike> = Buffer<ArrayBufferLike>

      Parameters

      • input: Uint8Array
      • out: TOut
      • OptionaloutOffset: number

      Returns TOut

    • Parameters

      • path: string
      • OptionalthrowOnError: boolean

      Returns Promise<Buffer<ArrayBufferLike>>

    • Parameters

      • paths: readonly string[]
      • Optionalconcurrency: number
      • OptionalthrowOnError: boolean

      Returns Promise<Buffer<ArrayBufferLike>>

    • Type Parameters

      • TOut extends Uint8Array<ArrayBufferLike>

      Parameters

      • paths: readonly string[]
      • out: TOut
      • OptionaloutOffset: number
      • Optionalconcurrency: number
      • OptionalthrowOnError: boolean

      Returns Promise<TOut>

    • Parameters

      • paths: readonly string[]
      • OptionalthrowOnError: boolean

      Returns Promise<Buffer<ArrayBufferLike>>

    • Type Parameters

      • TOut extends Uint8Array<ArrayBufferLike>

      Parameters

      • paths: readonly string[]
      • out: TOut
      • OptionaloutOffset: number
      • OptionalthrowOnError: boolean

      Returns Promise<TOut>

    • Type Parameters

      • TOut extends Uint8Array<ArrayBufferLike> = Buffer<ArrayBufferLike>

      Parameters

      • path: string
      • out: TOut
      • OptionaloutOffset: number
      • OptionalthrowOnError: boolean

      Returns Promise<TOut>

    • Parameters

      • input: string

      Returns Buffer

    • Type Parameters

      • TOut extends Uint8Array<ArrayBufferLike> = Buffer<ArrayBufferLike>

      Parameters

      • input: string
      • out: TOut
      • OptionaloutOffset: number

      Returns TOut