Skip to content

StaticBytes

@algorandfoundation/algorand-typescript


@algorandfoundation/algorand-typescript / arc4 / StaticBytes

Class: StaticBytes<TLength>

Defined in: packages/algo-ts/src/arc4/encoded-types.ts:527

A fixed length sequence of bytes

Extends

Type Parameters

TLength extends number = 0

Indexable

[index: uint64]: Byte

Constructors

new StaticBytes()

new StaticBytes<TLength>(value?): StaticBytes<TLength>

Defined in: packages/algo-ts/src/arc4/encoded-types.ts:535

Create a new StaticBytes instance

Parameters

value?

THe bytes or utf8 interpreted string to initialize this type

string | bytes

Returns

StaticBytes<TLength>

Overrides

Arc4ArrayBase.constructor

Accessors

bytes

Get Signature

get bytes(): bytes

Defined in: packages/algo-ts/src/arc4/encoded-types.ts:97

Retrieve the encoded bytes for this type

Returns

bytes

Inherited from

Arc4ArrayBase.bytes


length

Get Signature

get length(): uint64

Defined in: packages/algo-ts/src/arc4/encoded-types.ts:240

Returns the current length of this array

Returns

uint64

Inherited from

Arc4ArrayBase.length


native

Get Signature

get native(): bytes

Defined in: packages/algo-ts/src/arc4/encoded-types.ts:542

Get the native bytes value

Returns

bytes

Methods

[iterator]()

[iterator](): IterableIterator<Byte>

Defined in: packages/algo-ts/src/arc4/encoded-types.ts:277

Returns an iterator for the items in this array

Returns

IterableIterator<Byte>

Inherited from

Arc4ArrayBase.[iterator]


at()

at(index): Byte

Defined in: packages/algo-ts/src/arc4/encoded-types.ts:249

Returns the item at the given index. Negative indexes are taken from the end.

Parameters

index

Uint64Compat

The index of the item to retrieve

Returns

Byte

Inherited from

Arc4ArrayBase.at


concat()

concat(other): DynamicBytes

Defined in: packages/algo-ts/src/arc4/encoded-types.ts:550

Returns a dynamic bytes object containing all bytes from this and other

Parameters

other

Arc4ArrayBase<Byte>

Another array of bytes to concat with this one

Returns

DynamicBytes


entries()

entries(): IterableIterator<readonly [uint64, Byte]>

Defined in: packages/algo-ts/src/arc4/encoded-types.ts:284

Returns an iterator for a tuple of the indexes and items in this array

Returns

IterableIterator<readonly [uint64, Byte]>

Inherited from

Arc4ArrayBase.entries


keys()

keys(): IterableIterator<uint64>

Defined in: packages/algo-ts/src/arc4/encoded-types.ts:291

Returns an iterator for the indexes in this array

Returns

IterableIterator<uint64>

Inherited from

Arc4ArrayBase.keys


slice()

Call Signature

slice(): DynamicArray<Byte>

Defined in: packages/algo-ts/src/arc4/encoded-types.ts:256

Internal

Create a new Dynamic array with all items from this array

Returns

DynamicArray<Byte>

Inherited from

Arc4ArrayBase.slice

Call Signature

slice(end): DynamicArray<Byte>

Defined in: packages/algo-ts/src/arc4/encoded-types.ts:262

Internal

Create a new DynamicArray with all items up till end. Negative indexes are taken from the end.

Parameters
end

Uint64Compat

An index in which to stop copying items.

Returns

DynamicArray<Byte>

Inherited from

Arc4ArrayBase.slice

Call Signature

slice(start, end): DynamicArray<Byte>

Defined in: packages/algo-ts/src/arc4/encoded-types.ts:269

Internal

Create a new DynamicArray with items from start, up until end Negative indexes are taken from the end.

Parameters
start

Uint64Compat

An index in which to start copying items.

end

Uint64Compat

An index in which to stop copying items

Returns

DynamicArray<Byte>

Inherited from

Arc4ArrayBase.slice