Class JSON

A CBOR-tagged container for UTF-8 JSON text.

Wraps UTF-8 JSON text as a CBOR byte string with tag 262. This allows JSON data to be embedded within CBOR structures while maintaining type information through the tag.

Implements

CborTaggedEncodable
CborTaggedDecodable<JSON>

Methods

`Static`fromData

fromData(data: Uint8Array): JSON
Create a new JSON instance from byte data.
Parameters
- data: Uint8Array
Returns JSON
- Defined in components/src/json.ts:70

`Static`fromString

fromString(s: string): JSON
Create a new JSON instance from a string.
Parameters
- s: string
Returns JSON
- Defined in components/src/json.ts:77

`Static`fromHex

fromHex(hex: string): JSON
Create a new JSON instance from a hexadecimal string.
Parameters
- hex: string
Returns JSON
- Defined in components/src/json.ts:85

len

len(): number
Return the length of the JSON data in bytes.

Returns number
- Defined in components/src/json.ts:96

isEmpty

isEmpty(): boolean
Return true if the JSON data is empty.

Returns boolean
- Defined in components/src/json.ts:103

asBytes

asBytes(): Uint8Array
Return the data as a byte slice.

Returns Uint8Array
- Defined in components/src/json.ts:110

asStr

asStr(): string
Return the data as a UTF-8 string slice.

Returns string
Throws
Error if the data is not valid UTF-8.
- Defined in components/src/json.ts:119

hex

hex(): string
Return the data as a hexadecimal string.

Returns string
- Defined in components/src/json.ts:127

toData

toData(): Uint8Array
Return a copy of the underlying data.

Returns Uint8Array
- Defined in components/src/json.ts:134

equals

equals(other: JSON): boolean
Compare with another JSON.
Parameters
- other: JSON
Returns boolean
- Defined in components/src/json.ts:141

toString

toString(): string
Get string representation.

Returns string
- Defined in components/src/json.ts:152

cborTags

cborTags(): Tag[]
Returns the CBOR tags associated with JSON.

Returns Tag[]
Implementation of CborTaggedEncodable.cborTags
- Defined in components/src/json.ts:163

untaggedCbor

untaggedCbor(): Cbor
Returns the untagged CBOR encoding (as a byte string).

Returns Cbor
Implementation of CborTaggedEncodable.untaggedCbor
- Defined in components/src/json.ts:170

taggedCbor

taggedCbor(): Cbor
Returns the tagged CBOR encoding.

Returns Cbor
Implementation of CborTaggedEncodable.taggedCbor
- Defined in components/src/json.ts:177

taggedCborData

taggedCborData(): Uint8Array
Returns the tagged value in CBOR binary representation.

Returns Uint8Array
Implementation of CborTaggedEncodable.taggedCborData
- Defined in components/src/json.ts:184

fromUntaggedCbor

fromUntaggedCbor(cborValue: Cbor): JSON
Creates a JSON by decoding it from untagged CBOR.
Parameters
- cborValue: Cbor
Returns JSON
Implementation of CborTaggedDecodable.fromUntaggedCbor
- Defined in components/src/json.ts:195

fromTaggedCbor

fromTaggedCbor(cborValue: Cbor): JSON
Creates a JSON by decoding it from tagged CBOR.
Parameters
- cborValue: Cbor
Returns JSON
Implementation of CborTaggedDecodable.fromTaggedCbor
- Defined in components/src/json.ts:203

`Static`fromTaggedCbor

fromTaggedCbor(cborValue: Cbor): JSON
Static method to decode from tagged CBOR.
Parameters
- cborValue: Cbor
Returns JSON
- Defined in components/src/json.ts:212

`Static`fromTaggedCborData

fromTaggedCborData(data: Uint8Array): JSON
Static method to decode from tagged CBOR binary data.
Parameters
- data: Uint8Array
Returns JSON
- Defined in components/src/json.ts:220

`Static`fromUntaggedCborData

fromUntaggedCborData(data: Uint8Array): JSON
Static method to decode from untagged CBOR binary data.
Parameters
- data: Uint8Array
Returns JSON
- Defined in components/src/json.ts:228