Type Alias Box<TValue>

Readonlyexists

Readonlykey

Readonlylength

value

create

• create(options?: { size?: uint64 }): boolean

  Create the box for this proxy with a bzero value.

  • If options.size is specified, the box will be created with that length
  • Otherwise the box will be created with storage size of TValue. Errors if the size of TValue is not fixed

  No op if the box already exists with the same size Errors if the box already exists with a different size. Errors if the specified size is greater than the max box size (32,768)

  Parameters

  • Optionaloptions: { size?: uint64 }

  Returns boolean

  True if the box was created, false if it already existed

delete

• delete(): boolean

  Delete the box associated with this proxy if it exists.

  Returns boolean

  True if the box existed and was deleted, else false

extract

• extract(start: uint64, length: uint64): bytes

  Extract a slice of bytes from the box

  Error if the box does not exist Error if start + length is greater than the box size

  Parameters

  • start: uint64

    The index to start extracting
  • length: uint64

    The number of bytes to extract

  Returns bytes

  The extracted bytes

get

• get(options: { default: TValue }): TValue

  Get the value stored in the box, or return a specified default value if the box does not exist

  Parameters

  • options: { default: TValue }

    Options to specify a default value to be returned if no other value exists

  Returns TValue

  The value if the box exists, else the default value

maybe

• maybe(): readonly [TValue, boolean]

  Get the value stored in the box if available, and a boolean indicating if the box exists.

  If the box does not exist, the value returned at position 0 should not be relied on to have a valid value.

  Returns readonly [TValue, boolean]

  A tuple with the first item being the box value, and the second item being a boolean indicating if the box exists.

replace

• replace(start: uint64, value: bytes): void

  Replace bytes in a box starting at start.

  Error if the box does not exist Error if start + value.length is greater than the box size

  Parameters

  • start: uint64

    The index to start replacing
  • value: bytes

    The value to be written

  Returns void

resize

• resize(newSize: uint64): void

  Resize the box to the specified size.

  Adds zero bytes to the end if the new size is larger Removes end bytes if the new size is smaller Error if the box does not exist

  Parameters

  • newSize: uint64

    The new size for the box

  Returns void

splice

• splice(start: uint64, length: uint64, value: bytes): void

  Splice the specified bytes into the box starting at start, removing length bytes from the existing value and replacing them with value before appending the remainder of the original box value.

  If the resulting byte value is larger than length, bytes will be trimmed from the end If the resulting byte value is smaller than length, zero bytes will be appended to the end Error if the box does not exist

  Parameters

  • start: uint64

    The index to start inserting the value
  • length: uint64

    The number of bytes after start to be omitted
  • value: bytes

    The value to be inserted

  Returns void