Module util

@ndn/util

This package is part of NDNts, Named Data Networking libraries for the modern web.

This package contains general utilities used in NDNts codebase. This package cannot depend on other NDNts packages.

Index

Namespaces

Classes

Interfaces

Closer

Variables

Functions

Variables

Const console

console: Console = ...

Console on stderr.

Const crypto

crypto: Crypto = ...

Functions

asDataView

asDataView(a: BufferSource): DataView

- Defined in packages/util/src/buffer.ts:2
Convert ArrayBuffer or ArrayBufferView to DataView.

Parameters
- a: BufferSource
Returns DataView

flatMapOnce

flatMapOnce<T, R>(f: (item: T) => Iterable<R> | AsyncIterable<R>, iterable: AsyncIterable<T>): AsyncIterable<R>

- Defined in packages/util/src/iter.ts:17
Map and flatten once. This differs from flatMap in streaming-iterables, which recursively flattens the result.

Type parameters
- T
- R
Parameters
- f: (item: T) => Iterable<R> | AsyncIterable<R>
  - - (item: T): Iterable<R> | AsyncIterable<R>
    - Parameters
      - item: T
      Returns Iterable<R> | AsyncIterable<R>
- iterable: AsyncIterable<T>
Returns AsyncIterable<R>

fromHex

fromHex(s: string): Uint8Array

- Defined in packages/util/src/string.ts:32
Convert hexadecimal string to byte array.

If the input is not a valid hexadecimal string, result will be incorrect.

Parameters
- s: string
Returns Uint8Array

fromUtf8

fromUtf8(buf: Uint8Array): string

- Defined in packages/util/src/string.ts:54
Convert UTF-8 byte array to string.

Parameters
- buf: Uint8Array
Returns string

safeIter

safeIter<T>(iterable: AsyncIterable<T>, onError?: (err?: unknown) => void): AsyncIterableIterator<T>

- Defined in packages/util/src/iter.ts:2
Yield all values from an iterable but catch any error.

Type parameters
- T
Parameters
- iterable: AsyncIterable<T>
- Optional onError: (err?: unknown) => void
  - - (err?: unknown): void
    - Parameters
      - Optional err: unknown
      Returns void
Returns AsyncIterableIterator<T>

sha256

sha256(input: Uint8Array): Promise<Uint8Array>

- Defined in packages/util/src/crypto.ts:12
SHA256 digest.

Parameters
- input: Uint8Array
Returns Promise<Uint8Array>

timingSafeEqual

timingSafeEqual(a: Uint8Array, b: Uint8Array): boolean

- Defined in packages/util/src/crypto.ts:4
Timing-safe equality comparison.

Parameters
- a: Uint8Array
- b: Uint8Array
Returns boolean

toHex

toHex(buf: Uint8Array): string

- Defined in packages/util/src/string.ts:14
Convert byte array to upper-case hexadecimal string.

Parameters
- buf: Uint8Array
Returns string

toUtf8

toUtf8(s: string): Uint8Array

- Defined in packages/util/src/string.ts:49
Convert string to UTF-8 byte array.

Parameters
- s: string
Returns Uint8Array

Generated using TypeDoc