Class Bytes

Hierarchy

ClassForEach<number>
- Bytes

Implements

Iterable<number>

Index

Constructors

Properties

buffer end start

Accessors

capacity length reverse

Methods

[iterator] _append append appendArrayBuffer appendBytes appendString copy dateView find forEach has iterator join map slice toString attach fromString make

Constructors

`Private` constructor

new Bytes(buffer: ArrayBuffer, start: number, end: number): Bytes
Parameters
- buffer: ArrayBuffer
- start: number
- end: number
Returns Bytes
Overrides ClassForEach<number>.constructor
- Defined in src/slice.ts:285

Properties

`Readonly` buffer

buffer: ArrayBuffer

`Readonly` end

end: number

`Readonly` start

start: number

Accessors

capacity

get capacity(): number
return bytes capacity

Returns number
- Defined in src/slice.ts:301

length

get length(): number
return bytes length

Returns number
Overrides ClassForEach.length
- Defined in src/slice.ts:295

reverse

get reverse(): Iterable<number>
Sealed
Returns an object that implements a js Iterable, but it traverses the data in reverse

Returns Iterable<number>
- Defined in src/slice.ts:393

Methods

[iterator]

[iterator](): Iterator<number, any, undefined>
implements js Iterable

Sealedl

Returns Iterator<number, any, undefined>
Implementation of Iterable.__@iterator@40
- Defined in src/slice.ts:386

`Private` _append

_append(b: bytesLike): Bytes
Parameters
- b: bytesLike
Returns Bytes
- Defined in src/slice.ts:428

append

append(...vals: number[]): Bytes
Add a new element at the end of the slice and return the new slice
Parameters
- Rest ...vals: number[]
Returns Bytes
- Defined in src/slice.ts:401

appendArrayBuffer

appendArrayBuffer(...vals: ArrayBuffer[]): Bytes
Parameters
- Rest ...vals: ArrayBuffer[]
Returns Bytes
- Defined in src/slice.ts:415

appendBytes

appendBytes(...vals: Bytes[]): Bytes
Parameters
- Rest ...vals: Bytes[]
Returns Bytes
- Defined in src/slice.ts:408

appendString

appendString(str: string): Bytes
Parameters
- str: string
Returns Bytes
- Defined in src/slice.ts:422

copy

copy(src: Bytes): number
Parameters
- src: Bytes
Returns number
- Defined in src/slice.ts:336

dateView

dateView(): DataView
return DataView of Bytes

Returns DataView
- Defined in src/slice.ts:308

find

find(callback: ValidCallback<number>, reverse?: boolean): boolean
Traverse the container looking for elements until the callback returns true, then stop looking

Returns
whether the element was found
Parameters
- callback: ValidCallback<number>
  
  Determine whether it is the element to be found
- Optional reverse: boolean
  
  If true, traverse the container in reverse order
Returns boolean
Inherited from ClassForEach.find
- Defined in src/internal/decorator.ts:50

forEach

forEach(callback: ValueCallback<number>, reverse?: boolean): void
call callback on each element in the container in turn
Parameters
- callback: ValueCallback<number>
- Optional reverse: boolean
  
  If true, traverse the container in reverse order
Returns void
Inherited from ClassForEach.forEach
- Defined in src/internal/decorator.ts:36

has

has(data: number, reverse?: boolean, callback?: CompareCallback<number>): boolean
Returns whether the data data exists in the container
Parameters
- data: number
- Optional reverse: boolean
- Optional callback: CompareCallback<number>
Returns boolean
Inherited from ClassForEach.has
- Defined in src/internal/decorator.ts:60

iterator

iterator(reverse?: boolean): Iterator<number, any, undefined>
return js iterator
Parameters
- Optional reverse: boolean
  
  If true, returns an iterator to traverse in reverse
Returns Iterator<number, any, undefined>
Overrides ClassForEach.iterator
- Defined in src/slice.ts:352

join

join<TO>(separator?: string, callback?: MapCallback<number, TO>, reverse?: boolean): string
Adds all the elements of an container into a string, separated by the specified separator string.
Type Parameters
- TO
Parameters
- Optional separator: string
  
  A string used to separate one element of the container from the next in the resulting string. If omitted, the array elements are separated with a comma.
- Optional callback: MapCallback<number, TO>
- Optional reverse: boolean
  
  If true, traverse the container in reverse order
Returns string
Inherited from ClassForEach.join
- Defined in src/internal/decorator.ts:83

map

map<TO>(callback: MapCallback<number, TO>, reverse?: boolean): TO[]
Convert container to array
Type Parameters
- TO
Parameters
- callback: MapCallback<number, TO>
- Optional reverse: boolean
  
  If true, traverse the container in reverse order
Returns TO[]
Inherited from ClassForEach.map
- Defined in src/internal/decorator.ts:72

slice

slice(start?: number, end?: number): Bytes
take sub-slices

Throws
TypeError

Throws
RangeError
Parameters
- Optional start: number
- Optional end: number
Returns Bytes
- Defined in src/slice.ts:316

toString

toString(): string
Returns string
- Defined in src/slice.ts:462

`Static` attach

attach(b: ArrayBuffer, start?: number, end?: number): Bytes
Creates a Bytes attached to the incoming ArrayBuffer

Throws
TypeError

Throws
RangeError
Parameters
- b: ArrayBuffer
- Optional start: number
- Optional end: number
Returns Bytes
- Defined in src/slice.ts:238

`Static` fromString

fromString(str: string): Bytes
Create a Bytes from string
Parameters
- str: string
Returns Bytes
- Defined in src/slice.ts:281

`Static` make

make(length: number, capacity?: number): Bytes
Create a Bytes

Throws
TypeError

Throws
RangeError
Parameters
- length: number
- Optional capacity: number
Returns Bytes
- Defined in src/slice.ts:262

Generated using TypeDoc