Class Slice<T>

Type Parameters

T

Hierarchy

ClassForEach<T>
- Slice

Implements

Iterable<T>

Index

Constructors

Properties

array end start

Accessors

capacity length reverse

Methods

[iterator] append copy find forEach get has iterator join map set slice attach make

Constructors

`Private` constructor

new Slice<T>(array: T[], start: number, end: number): Slice<T>
Type Parameters
- T
Parameters
- array: T[]
- start: number
- end: number
Returns Slice<T>
Overrides ClassForEach<T>.constructor
- Defined in src/slice.ts:51

Properties

`Readonly` array

array: T[]

`Readonly` end

end: number

`Readonly` start

start: number

Accessors

capacity

get capacity(): number
return slice capacity

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

length

get length(): number
return slice length

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

reverse

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

Returns Iterable<T>
- Defined in src/slice.ts:211

Methods

[iterator]

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

Sealedl

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

append

append(...vals: T[]): Slice<T>
Add a new element at the end of the slice and return the new slice
Parameters
- Rest ...vals: T[]
Returns Slice<T>
- Defined in src/slice.ts:145

copy

copy(src: Iterable<T>): number
Copy data from src to current slice

Returns
How much data was copied
Parameters
- src: Iterable<T>
Returns number
- Defined in src/slice.ts:127

find

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

get

get(i: number): T
Returns the element at index i in the slice

Throws
TypeError

Throws
RangeError
Parameters
- i: number
Returns T
- Defined in src/slice.ts:63

has

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

iterator

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

join

join<TO>(separator?: string, callback?: MapCallback<T, 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<T, 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<T, TO>, reverse?: boolean): TO[]
Convert container to array
Type Parameters
- TO
Parameters
- callback: MapCallback<T, 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

set

set(i: number, val: T): void
Sets the element at index i in the slice to val

Throws
TypeError

Throws
RangeError
Parameters
- i: number
- val: T
Returns void
- Defined in src/slice.ts:77

slice

slice(start?: number, end?: number): Slice<T>
take sub-slices

Throws
TypeError

Throws
RangeError
Parameters
- Optional start: number
- Optional end: number
Returns Slice<T>
- Defined in src/slice.ts:103

`Static` attach

attach<T>(a: T[], start?: number, end?: number): Slice<T>
Creates a slice attached to the incoming array

Throws
TypeError

Throws
RangeError
Type Parameters
- T
Parameters
- a: T[]
- Optional start: number
- Optional end: number
Returns Slice<T>
- Defined in src/slice.ts:11

`Static` make

make<T>(length: number, capacity?: number): Slice<T>
Create a slice

Throws
TypeError

Throws
RangeError
Type Parameters
- T
Parameters
- length: number
- Optional capacity: number
Returns Slice<T>
- Defined in src/slice.ts:35

Generated using TypeDoc