Class Identifier

description: An identifier encodes information about our LSAT that can be used as a unique identifier and is used to generate a macaroon.
extends: Struct

Hierarchy

any
- Identifier

Index

Constructors

constructor

Methods

Constructors

constructor

new Identifier(options: IdentifierOptions | void): Identifier

- Defined in src/identifier.ts:33
Parameters
- options: IdentifierOptions | void
  
  options to create a new Identifier
Returns Identifier

Methods

fromOptions

fromOptions(options: IdentifierOptions): this

- Defined in src/identifier.ts:51
Parameters
- options: IdentifierOptions
Returns this

read

read(br: any): this

- Defined in src/identifier.ts:127
Utility for reading raw Identifier bytes and converting to a new Identifier

Parameters
- br: any
  
  Buffer Reader to read bytes
Returns this

toString

toString(): string

- Defined in src/identifier.ts:86
Convert lsat to string

Returns string

write

write(bw: any): this

- Defined in src/identifier.ts:99
Utility for encoding the Identifier into a buffer based on version

Parameters
- bw: any
  
  Buffer writer for creating an Identifier Buffer
Returns this

Static fromString

fromString(str: string): Identifier

- Defined in src/identifier.ts:90
Parameters
- str: string
Returns Identifier

Generated using TypeDoc