Interface Crypto

Importing the webcrypto object (import { webcrypto } from 'node:crypto') gives an instance of the Crypto class. Crypto is a singleton that provides access to the remainder of the crypto API.

Since

v15.0.0

interface Crypto {
    CryptoKey: CryptoKeyConstructor;
    subtle: SubtleCrypto;
    getRandomValues<T>(typedArray: T): T;
    randomUUID(): `${string}-${string}-${string}-${string}-${string}`;
}

Properties

CryptoKey subtle

Methods

getRandomValues randomUUID

Properties

CryptoKey

CryptoKey: CryptoKeyConstructor

Readonlysubtle

subtle: SubtleCrypto

Provides access to the SubtleCrypto API.

Since

v15.0.0

Methods

getRandomValues

  • getRandomValues<T>(typedArray): T

  • Generates cryptographically strong random values. The given typedArray is filled with random values, and a reference to typedArray is returned.

    The given typedArray must be an integer-based instance of NodeJS.TypedArray, i.e. Float32Array and Float64Array are not accepted.

    An error will be thrown if the given typedArray is larger than 65,536 bytes.

    Type Parameters

    • T extends
          | Uint8Array
          | Uint8ClampedArray
          | Uint16Array
          | Uint32Array
          | Int8Array
          | Int16Array
          | Int32Array
          | BigUint64Array
          | BigInt64Array

    Parameters

    • typedArray: T

    Returns T

    Since

    v15.0.0

randomUUID

  • randomUUID(): `${string}-${string}-${string}-${string}-${string}`

  • Generates a random RFC 4122 version 4 UUID. The UUID is generated using a cryptographic pseudorandom number generator.

    Returns `${string}-${string}-${string}-${string}-${string}`

    Since

    v16.7.0

Settings

Member Visibility

On This Page

Properties
Methods