Crypto Vue
    Preparing search index...

    Interface UsePqStreamReturn

    Reactive state and methods returned by usePqStream.

    interface UsePqStreamReturn {
        ciphertext: DeepReadonly<Ref<Uint8Array | null>>;
        plaintext: DeepReadonly<Ref<Uint8Array | null>>;
        chunkCount: DeepReadonly<Ref<number | null>>;
        isProcessing: DeepReadonly<Ref<boolean>>;
        error: DeepReadonly<Ref<Error | null>>;
        encrypt: (
            data: 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>,
        >;
        clear: () => void;
    }
    Index
    ciphertext: DeepReadonly<Ref<Uint8Array | null>>

    The most recent ciphertext (Uint8Array bytes).

    plaintext: DeepReadonly<Ref<Uint8Array | null>>

    The most recent decrypted plaintext (Uint8Array bytes).

    chunkCount: DeepReadonly<Ref<number | null>>

    Number of chunks processed in the last encryption.

    isProcessing: DeepReadonly<Ref<boolean>>

    Whether an encrypt/decrypt operation is in progress.

    error: DeepReadonly<Ref<Error | null>>

    Error from the last operation, if any.

    encrypt: (
        data: 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.

    clear: () => void

    Reset all reactive state.