Skip to main content Link Search Menu Expand Document (external link)

Secret.ts overview

Since v2.0.0


Exports Grouped by Category


constructors

fromIterable

Signature

declare const fromIterable: (iterable: Iterable<string>) => Secret

Source

Since v2.0.0

fromString

Signature

declare const fromString: (text: string) => Secret

Source

Since v2.0.0

make

Signature

declare const make: (bytes: Array<number>) => Secret

Source

Since v2.0.0

getters

value

Signature

declare const value: (self: Secret) => string

Source

Since v2.0.0

models

Secret (interface)

Signature

export interface Secret extends Redacted.Redacted, Secret.Proto, Equal.Equal {
  /** @internal */
  readonly raw: Array<number>
}

Source

Since v2.0.0

refinements

isSecret

Signature

declare const isSecret: (u: unknown) => u is Secret

Source

Since v2.0.0

symbols

SecretTypeId

Signature

declare const SecretTypeId: unique symbol

Source

Since v2.0.0

SecretTypeId (type alias)

Signature

type SecretTypeId = typeof SecretTypeId

Source

Since v2.0.0

unsafe

unsafeWipe

Signature

declare const unsafeWipe: (self: Secret) => void

Source

Since v2.0.0

utils

Secret (namespace)

Source

Since v2.0.0

Proto (interface)

Signature

export interface Proto {
  readonly [SecretTypeId]: SecretTypeId
}

Source

Since v2.0.0