Class Basic<T>

The base class of the container implements some common methods for the container

Type Parameters

Hierarchy

ClassForEach<T>
- Basic
  - Heap
  - List
  - Queue

Index

Constructors

`Protected` constructor

new Basic<T>(opts?: Options<T>): Basic<T>
Type Parameters
- T
Parameters
- Optional opts: Options<T>
Returns Basic<T>
Overrides ClassForEach<T>.constructor
- Defined in src/container/types.ts:117

Properties

`Protected` opts_

opts_: undefined | Options<T>

Accessors

capacity

get capacity(): number
Returns the current capacity of the container

Returns number
- Defined in src/container/types.ts:127

isEmpty

get isEmpty(): boolean
Returns true if there is no data in the container

Returns boolean
- Defined in src/container/types.ts:135

isFull

get isFull(): boolean
Returns true if the container has reached the container limit

Returns boolean
- Defined in src/container/types.ts:151

isNotEmpty

get isNotEmpty(): boolean
Returns true if there is data in the container

Returns boolean
- Defined in src/container/types.ts:143

isNotFull

get isNotFull(): boolean
Returns true if the container has not reached the container limit

Returns boolean
- Defined in src/container/types.ts:159

length

get length(): number
Returns number
Inherited from ClassForEach.length
- Defined in src/internal/decorator.ts:24

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/container/types.ts:215

Methods

[iterator]

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

Sealedl

Returns Iterator<T, any, undefined>
- Defined in src/container/types.ts:208

compareTo

compareTo(o: Container<T>, callback?: CompareCallback<T>): number
Returns true if the data depth of the two containers is consistent
Parameters
- o: Container<T>
- Optional callback: CompareCallback<T>
Returns number
- Defined in src/container/types.ts:181

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

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>
Returns a 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/container/types.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

Class Basic<T>

Type Parameters

T

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

Protected constructor

Type Parameters

T

Parameters

Optional opts: Options<T>

Returns Basic<T>

Properties

Protected opts_

Accessors

capacity

Returns number

isEmpty

Returns boolean

isFull

Returns boolean

isNotEmpty

Returns boolean

isNotFull

Returns boolean

length

Returns number

reverse

Returns Iterable<T>

Methods

[iterator]

Sealedl

Returns Iterator<T, any, undefined>

compareTo

Parameters

o: Container<T>

Optional callback: CompareCallback<T>

Returns number

find

Returns

Parameters

callback: ValidCallback<T>

Optional reverse: boolean

Returns boolean

forEach

Parameters

callback: ValueCallback<T>

Optional reverse: boolean

Returns void

has

Parameters

data: T

Optional reverse: boolean

Optional callback: CompareCallback<T>

Returns boolean

iterator

Parameters

Optional reverse: boolean

Returns Iterator<T, any, undefined>

join

Type Parameters

TO

Parameters

Optional separator: string

Optional callback: MapCallback<T, TO>

Optional reverse: boolean

Returns string

map

Type Parameters

TO

Parameters

callback: MapCallback<T, TO>

Optional reverse: boolean

Returns TO[]

Settings

Member Visibility

`Protected` constructor

`Optional` opts: Options<T>

`Protected` opts_

`Optional` callback: CompareCallback<T>

`Optional` reverse: boolean

`Optional` reverse: boolean

`Optional` reverse: boolean

`Optional` callback: CompareCallback<T>

`Optional` reverse: boolean

`Optional` separator: string

`Optional` callback: MapCallback<T, TO>

`Optional` reverse: boolean

`Optional` reverse: boolean