CustomPath
Defined in: packages/agent/src/canisterStatus/index.ts:76
Interface to define a custom path. Nested paths will be represented as individual buffers, and can be created from text using TextEncoder.
the key to use to access the returned value in the canisterStatus map
the path to the desired value, represented as an array of buffers
the strategy to use to decode the returned value
Implements
Section titled “Implements”CustomPath
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new CustomPath(
key,path,decodeStrategy):CustomPath
Defined in: packages/agent/src/canisterStatus/index.ts:80
Parameters
Section titled “Parameters”string
string | Uint8Array<ArrayBufferLike>[]
decodeStrategy
Section titled “decodeStrategy”"cbor" | "hex" | "leb128" | "utf-8" | "raw"
Returns
Section titled “Returns”CustomPath
Properties
Section titled “Properties”decodeStrategy
Section titled “decodeStrategy”decodeStrategy:
"cbor"|"hex"|"leb128"|"utf-8"|"raw"
Defined in: packages/agent/src/canisterStatus/index.ts:79
Implementation of
Section titled “Implementation of”CustomPath.decodeStrategy
key:
string
Defined in: packages/agent/src/canisterStatus/index.ts:77
Implementation of
Section titled “Implementation of”CustomPath.key
path:
string|Uint8Array<ArrayBufferLike>[]
Defined in: packages/agent/src/canisterStatus/index.ts:78
Implementation of
Section titled “Implementation of”CustomPath.path