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

Secret overview

Added in v2.0.0


Table of contents


constructors

fromIterable

Signature

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

Added in v2.0.0

fromString

Signature

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

Added in v2.0.0

make

Signature

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

Added in v2.0.0

getters

value

Signature

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

Added in v2.0.0

models

Secret (interface)

Signature

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

Added in v2.0.0

refinements

isSecret

Signature

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

Added in v2.0.0

symbols

SecretTypeId

Signature

export declare const SecretTypeId: typeof SecretTypeId

Added in v2.0.0

SecretTypeId (type alias)

Signature

export type SecretTypeId = typeof SecretTypeId

Added in v2.0.0

unsafe

unsafeWipe

Signature

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

Added in v2.0.0

utils

Secret (namespace)

Added in v2.0.0

Proto (interface)

Signature

export interface Proto {
  readonly [SecretTypeId]: SecretTypeId
}

Added in v2.0.0