util reference - RevoEngine

Generated from the same public contract that feeds the Monaco editor. Declaration-marked deprecated compatibility methods are intentionally excluded. Do not edit this page manually.

This page contains 33 methods. Search the docs for an exact method name, or use this index:

util.sleep()
util.aesDecrypt()
util.aesEncrypt()
util.compareHash()
util.isBase64()
util.decodeBase64()
util.encodeBase64()
util.generateHash()
util.isUUID()
util.randomUUID()
util.getUUID()
util.hashObject()
util.sha1()
util.sha256()
util.md5()
util.timingSafeEqual()
util.hmac()
util.verifyHmacSignature()
util.base64UrlEncode()
util.base64UrlDecode()
util.randomBytes()
util.randomInt()
util.randomString()
util.otp()
util.validate()
util.jwtDecode()
util.jwtSign()
util.jwtVerify()
util.rsaDecrypt()
util.rsaEncrypt()
util.rsaGeneratePair()
util.rsaSign()
util.rsaVerify()

`util.sleep()`

Waits asynchronously, capped at 60 seconds per call.

Signature

static sleep(ms: number): Promise<void>;

Example

await util.sleep(250);

`util.aesDecrypt()`

AES decrypt helper. Ciphertext: at most 5592464 base64 characters; passphrase: at most 4096 UTF-16 code units.

Signature

static aesDecrypt(encrypted: string, passphrase: string): Promise<string>;

Example

const plain = await util.aesDecrypt(encrypted, passphrase);

`util.aesEncrypt()`

AES encrypt helper. Payload: at most 1048576 UTF-16 code units; passphrase: at most 4096.

Signature

static aesEncrypt(payload: string, passphrase: string): Promise<string>;

Example

const encrypted = await util.aesEncrypt('secret', passphrase);

`util.compareHash()`

Compares a value against a password hash. Password: at most 4096 UTF-16 code units; unsupported scrypt work factors return false.

Signature

static compareHash(
      password: string | undefined,
      hash: string | undefined,
    ): Promise<boolean>;

Example

const valid = await util.compareHash(password, hash);

`util.isBase64()`

Checks whether a value is base64.

Signature

static isBase64(input: any): boolean;

Example

const ok = util.isBase64(value);

`util.decodeBase64()`

Decodes a base64 string.

Signature

static decodeBase64(base64String: string): string;

Example

const text = util.decodeBase64(base64String);

`util.encodeBase64()`

Encodes a string to base64.

Signature

static encodeBase64(plainString: string): string;

Example

const encoded = util.encodeBase64('hello');

`util.generateHash()`

Generates a password hash. Password: at most 4096 UTF-16 code units.

Signature

static generateHash(
      password: string | undefined,
      rounds?: number,
    ): Promise<string>;

Example

const hash = await util.generateHash(password, 10);

`util.isUUID()`

Validates UUID shape.

Signature

static isUUID(input: any): boolean;

Example

const ok = util.isUUID(value);

`util.randomUUID()`

Generates a random UUIDv7.

Signature

static randomUUID(): string;

Example

const id = util.randomUUID();

`util.getUUID()`

Returns a random UUIDv7 with no arguments, or a deterministic UUIDv5 only when both value and namespace are supplied. Do not generate IDs for server-created platform resources; use this only for caller-owned data values.

Signature

static getUUID(...args: [] | [value: string, namespace: string]): string;

Example

const id = util.getUUID('customer-1', 'customers');

`util.hashObject()`

Creates a stable hash from an object.

Signature

static hashObject(object: any): string;

Example

const hash = util.hashObject({ customerId: 'c-1' });

`util.sha1()`

Synchronous SHA-1 hash. Payload: at most 5242880 UTF-8 bytes (5 MiB). Invalid types/options throw TypeError; size/range throws RangeError.

Signature

static sha1(payload: string): string;

Example

const digest = util.sha1('payload');

`util.sha256()`

Synchronous SHA-256 hash. Payload: at most 5242880 UTF-8 bytes (5 MiB). Invalid types/options throw TypeError; size/range throws RangeError.

Signature

static sha256(payload: string): string;

Example

const digest = util.sha256('payload');

`util.md5()`

Synchronous MD5 hash. Payload: at most 5242880 UTF-8 bytes (5 MiB). Invalid types/options throw TypeError; size/range throws RangeError.

Signature

static md5(payload: string): string;

Example

const digest = util.md5('payload');

`util.timingSafeEqual()`

Synchronous timing-safe comparison. Each input: at most 65536 bytes (UTF-8 for strings). Invalid types/options throw TypeError; size/range throws RangeError.

Signature

static timingSafeEqual(a: string | Buffer, b: string | Buffer): boolean;

Example

const match = util.timingSafeEqual(a, b);

`util.hmac()`

Synchronous HMAC signature. Payload: at most 5242880 bytes; secret: at most 65536 UTF-8 bytes. Invalid types/options throw TypeError; size/range throws RangeError.

Signature

static hmac(
      payload: Uint8Array | string,
      secret: string,
      algorithm?: 'sha1' | 'sha256' | 'sha512',
      encoding?: 'hex' | 'base64',
    ): string;

Example

const signature = util.hmac('payload', secret, 'sha256', 'hex');

`util.verifyHmacSignature()`

Synchronous HMAC verification. Payload: at most 5242880 bytes; secret and signature: at most 65536 UTF-8 bytes each. Invalid types/options throw TypeError; size/range throws RangeError.

Signature

static verifyHmacSignature(
      payload: Uint8Array | string,
      signature: string,
      secret: string,
      algorithm?: 'sha1' | 'sha256' | 'sha512',
      encoding?: 'hex' | 'base64',
    ): boolean;

Example

const ok = util.verifyHmacSignature('payload', signature, secret);

`util.base64UrlEncode()`

Encodes base64url.

Signature

static base64UrlEncode(input: Uint8Array | string): string;

Example

const encoded = util.base64UrlEncode('payload');

`util.base64UrlDecode()`

Decodes base64url.

Signature

static base64UrlDecode(input: string): Uint8Array;

Example

const decoded = util.base64UrlDecode(tokenPart);

`util.randomBytes()`

Synchronously generates random bytes as a string. Size: integer 0..65536 bytes before encoding. Invalid types/options throw TypeError; size/range throws RangeError.

Signature

static randomBytes(size?: number, encoding?: 'hex' | 'base64'): string;

Example

const bytes = util.randomBytes(16, 'hex');

`util.randomInt()`

Synchronously generates a random integer in the inclusive min..max range. Bounds and max + 1 must be safe integers; range size must be smaller than 2^48. Invalid types/options throw TypeError; size/range throws RangeError.

Signature

static randomInt(min?: number, max?: number): number;

Example

const n = util.randomInt(1000, 9999);

`util.randomString()`

Generates a random string. Length: integer 0..65536. Alphabet: 1..65536 UTF-16 code units.

Signature

static randomString(length?: number, alphabet?: string): string;

Example

const token = util.randomString(24);

`util.otp()`

Generates a numeric one-time code. Length: integer 0..65536.

Signature

static otp(length?: number): string;

Example

const code = util.otp(6);

`util.validate()`

Validates a payload with the platform schema validator used by Endpoints. Notes:

Prefer enum/const, types, lengths, numeric bounds and supported date/time formats over regex when equivalent.
Use regex only for a required text pattern; even simple patterns can materially increase Endpoint guard preparation time.
Use profile: ‘strict’ for new schemas; omitted profiles retain legacy behavior.
required controls presence, nullable controls null, and empty controls empty strings and arrays.
Use additionalProperties: ‘allow’, ‘strip’ or ‘reject’ for unknown fields.
Legacy whitelist: true retains unknown fields. With whitelist: false, whitelistErrors: false removes them; true reports errors.
The result contains valid, errors, issues and value. Structured issues expose code, path, message and optional params.
After success, use value so configured field removal is respected.
Input, schema and execution limits apply; cyclic data is rejected. Capacity or execution failures can reject the Promise.

Signature

static validate(
      payload: any,
      schema: ValidatorSchemaInput,
    ): Promise<ValidationResult<any>>;

Example

const result = await util.validate(
  api.input()?.body,
  {
    profile: 'strict',
    additionalProperties: 'reject',
    schema: {
      type: 'object',
      required: true,
      objectSchema: [
        { property: 'status', schema: { type: 'string', required: true, enum: ['pending', 'ready'] } },
      ],
    },
  },
);
if (!result.valid) throw new Error('Invalid request');
const validatedInput = result.value;

`util.jwtDecode()`

Decodes a JWT without verifying it.

Signature

static jwtDecode(
      token: string,
      options?: { complete?: boolean; json?: boolean },
    ): any;

Example

const payload = util.jwtDecode(token);

`util.jwtSign()`

Signs a JWT.

Signature

static jwtSign(
      payload: string | object,
      secret: string | { key: string; passphrase: string },
      options?: {
        algorithm?:
          | 'HS256'
          | 'HS384'
          | 'HS512'
          | 'RS256'
          | 'RS384'
          | 'RS512'
          | 'ES256'
          | 'ES384'
          | 'ES512'
          | 'PS256'
          | 'PS384'
          | 'PS512'
          | 'none';
        keyid?: string;
        expiresIn?: string | number;
        notBefore?: string | number;
        audience?: string | string[];
        subject?: string;
        issuer?: string;
        jwtid?: string;
        mutatePayload?: boolean;
        noTimestamp?: boolean;
        header?: JWTHeader;
        encoding?: string;
        allowInsecureKeySizes?: boolean;
        allowInvalidAsymmetricKeyTypes?: boolean;
      },
    ): string;

Example

const token = util.jwtSign(
  { sub: 'c-1' },
  secret,
  { expiresIn: '1h' },
);

`util.jwtVerify()`

Verifies a JWT.

Signature

static jwtVerify(
      token: string,
      secret: string | { key: string; passphrase: string },
      options?: {
        algorithms?: (
          | 'HS256'
          | 'HS384'
          | 'HS512'
          | 'RS256'
          | 'RS384'
          | 'RS512'
          | 'ES256'
          | 'ES384'
          | 'ES512'
          | 'PS256'
          | 'PS384'
          | 'PS512'
          | 'none'
        )[];
        audience?: string | RegExp | Array<string | RegExp>;
        clockTimestamp?: number;
        clockTolerance?: number;
        complete?: boolean;
        issuer?: string | string[];
        ignoreExpiration?: boolean;
        ignoreNotBefore?: boolean;
        jwtid?: string;
        nonce?: string;
        subject?: string;
        maxAge?: string | number;
        allowInvalidAsymmetricKeyTypes?: boolean;
      },
    ): any;

Example

const payload = util.jwtVerify(token, secret);

`util.rsaDecrypt()`

Decrypts with RSA-OAEP and SHA-256 asynchronously. PEM import (including passphrase processing) still executes synchronously.

Signature

static rsaDecrypt(
      privateKey: string,
      payload: string,
      passphrase?: string,
    ): Promise<string>;

Example

const plain = await util.rsaDecrypt(privateKey, encrypted, passphrase);

`util.rsaEncrypt()`

Encrypts with RSA-OAEP and SHA-256 asynchronously. PEM import and data encoding still execute synchronously.

Signature

static rsaEncrypt(publicKey: string, payload: string): Promise<string>;

Example

const encrypted = await util.rsaEncrypt(publicKey, 'hello');

`util.rsaGeneratePair()`

Generates an RSA key pair. Asynchronous; modulusLength: multiple of 256 in 1024..4096; passphrase: at most 4096 code units.

Signature

static rsaGeneratePair(config?: {
      modulusLength?: number;
      passphrase?: string;
    }): Promise<{ publicKey: string; privateKey: string }>;

Example

const pair = await util.rsaGeneratePair({ modulusLength: 2048 });

`util.rsaSign()`

Signs data with RSA-PSS and SHA-256 asynchronously. PEM import and input conversion can still occupy the event loop.

Signature

static rsaSign(
      privateKey: string,
      payload: string,
      passphrase?: string,
    ): Promise<string>;

Example

const signature = await util.rsaSign(privateKey, 'hello', passphrase);

`util.rsaVerify()`

Verifies an RSA-PSS SHA-256 signature asynchronously, preserving automatic salt-length detection.

Signature

static rsaVerify(
      publicKey: string,
      payload: string,
      signature: string,
    ): Promise<boolean>;

Example

const ok = await util.rsaVerify(publicKey, 'hello', signature);

​util.sleep()

​Signature

​Example

​util.aesDecrypt()

​Signature

​Example

​util.aesEncrypt()

​Signature

​Example

​util.compareHash()

​Signature

​Example

​util.isBase64()

​Signature

​Example

​util.decodeBase64()

​Signature

​Example

​util.encodeBase64()

​Signature

​Example

​util.generateHash()

​Signature

​Example

​util.isUUID()

​Signature

​Example

​util.randomUUID()

​Signature

​Example

​util.getUUID()

​Signature

​Example

​util.hashObject()

​Signature

​Example

​util.sha1()

​Signature

​Example

​util.sha256()

​Signature

​Example

​util.md5()

​Signature

​Example

​util.timingSafeEqual()

​Signature

​Example

​util.hmac()

​Signature

​Example

​util.verifyHmacSignature()

​Signature

​Example

​util.base64UrlEncode()

​Signature

​Example

​util.base64UrlDecode()

​Signature

​Example

​util.randomBytes()

​Signature

​Example

​util.randomInt()

​Signature

​Example

​util.randomString()

​Signature

​Example

​util.otp()

​Signature

​Example

​util.validate()

​Signature

​Example

​util.jwtDecode()

​Signature

​Example

​util.jwtSign()

​Signature

`util.sleep()`

Signature

Example

`util.aesDecrypt()`

Signature

Example

`util.aesEncrypt()`

Signature

Example

`util.compareHash()`

Signature

Example

`util.isBase64()`

Signature

Example

`util.decodeBase64()`

Signature

Example

`util.encodeBase64()`

Signature

Example

`util.generateHash()`

Signature

Example

`util.isUUID()`

Signature

Example

`util.randomUUID()`

Signature

Example

`util.getUUID()`

Signature

Example

`util.hashObject()`

Signature

Example

`util.sha1()`

Signature

Example

`util.sha256()`

Signature

Example

`util.md5()`

Signature

Example

`util.timingSafeEqual()`

Signature

Example

`util.hmac()`

Signature

Example

`util.verifyHmacSignature()`

Signature

Example

`util.base64UrlEncode()`

Signature

Example

`util.base64UrlDecode()`

Signature

Example

`util.randomBytes()`

Signature

Example

`util.randomInt()`

Signature

Example

`util.randomString()`

Signature

Example

`util.otp()`

Signature

Example

`util.validate()`

Signature

Example

`util.jwtDecode()`

Signature

Example

`util.jwtSign()`

Signature