Crypto React
    Preparing search index...

    Interface UsePqStreamResult

    Return type of the usePqStream hook.

    interface UsePqStreamResult {
        encrypt: (
            plaintext: string | Uint8Array<ArrayBufferLike>,
            keys: PqRecipientPublicKeys,
            chunkSize?: number,
        ) => Promise<Uint8Array<ArrayBufferLike>>;
        decrypt: (
            ciphertext: Uint8Array,
            keys: PqRecipientSecretKeys,
            chunkSize?: number,
        ) => Promise<Uint8Array<ArrayBufferLike>>;
        createEncryptStream: (
            keys: PqRecipientPublicKeys,
            chunkSize?: number,
        ) => TransformStream<
            Uint8Array<ArrayBufferLike>,
            Uint8Array<ArrayBufferLike>,
        >;
        createDecryptStream: (
            keys: PqRecipientSecretKeys,
            chunkSize?: number,
        ) => TransformStream<
            Uint8Array<ArrayBufferLike>,
            Uint8Array<ArrayBufferLike>,
        >;
        ciphertext: Uint8Array<ArrayBufferLike> | null;
        plaintext: Uint8Array<ArrayBufferLike> | null;
        chunkCount: number | null;
        isProcessing: boolean;
        clear: () => void;
    }
    Index
    encrypt: (
        plaintext: string | Uint8Array<ArrayBufferLike>,
        keys: PqRecipientPublicKeys,
        chunkSize?: number,
    ) => Promise<Uint8Array<ArrayBufferLike>>

    Encrypt plaintext into post-quantum hybrid STREAM AEAD ciphertext bytes.

    decrypt: (
        ciphertext: Uint8Array,
        keys: PqRecipientSecretKeys,
        chunkSize?: number,
    ) => Promise<Uint8Array<ArrayBufferLike>>

    Decrypt post-quantum hybrid STREAM AEAD ciphertext bytes into plaintext.

    createEncryptStream: (
        keys: PqRecipientPublicKeys,
        chunkSize?: number,
    ) => TransformStream<
        Uint8Array<ArrayBufferLike>,
        Uint8Array<ArrayBufferLike>,
    >

    Create a WHATWG TransformStream that encrypts chunks with PQ hybrid STREAM AEAD.

    createDecryptStream: (
        keys: PqRecipientSecretKeys,
        chunkSize?: number,
    ) => TransformStream<
        Uint8Array<ArrayBufferLike>,
        Uint8Array<ArrayBufferLike>,
    >

    Create a WHATWG TransformStream that decrypts PQ hybrid STREAM AEAD chunks.

    ciphertext: Uint8Array<ArrayBufferLike> | null

    The last ciphertext produced by encrypt().

    plaintext: Uint8Array<ArrayBufferLike> | null

    The last plaintext produced by decrypt().

    chunkCount: number | null

    The chunk count from the last encrypt() call.

    isProcessing: boolean

    True while an encrypt or decrypt operation is in progress.

    clear: () => void

    Reset all hook state.