Interface Container<T>

container interface

Remarks

Describes the methods and properties that all containers have

Type Parameters

Hierarchy

Comparable<T>
Iterable<T>
- Container

Implemented by

Heap
List

Index

Properties

`Readonly` capacity

capacity: number

Returns the current capacity of the container

`Readonly` isEmpty

isEmpty: boolean

Returns true if there is no data in the container

`Readonly` isFull

isFull: boolean

Returns true if the container has reached the container limit

`Readonly` isNotEmpty

isNotEmpty: boolean

Returns true if there is data in the container

`Readonly` isNotFull

isNotFull: boolean

Returns true if the container has not reached the container limit

`Readonly` length

length: number

Returns the current amount of data in the container

Accessors

reverse

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

Returns Iterable<T>
- Defined in src/container/types.ts:61

Methods

[iterator]

[iterator](): Iterator<T, any, undefined>
Returns Iterator<T, any, undefined>
Inherited from Iterable.__@iterator@40
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:51

clear

clear(callback?: DeleteCallback<T>): void
Empty the data in the container
Parameters
- Optional callback: DeleteCallback<T>
  
  Call callback on the removed element
Returns void
- Defined in src/container/types.ts:45

clone

clone(callback?: CloneCallback<T>): Container<T>
Create a full copy of the container
Parameters
- Optional callback: CloneCallback<T>
  
  How to create a duplicate copy of an element
Returns Container<T>
- Defined in src/container/types.ts:39

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
Overrides Comparable.compareTo
- Defined in src/container/types.ts:50

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
- Defined in src/container/types.ts:75

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
- Defined in src/container/types.ts:67

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
  
  If true, traverse the container in reverse order
- Optional callback: CompareCallback<T>
Returns boolean
- Defined in src/container/types.ts:86

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>
- Defined in src/container/types.ts:57

join

join(separator?: string): string
Adds all the elements of an container into a string, separated by the specified separator string.
Parameters
- Optional separator: string
Returns string
- Defined in src/container/types.ts:93

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[]
- Defined in src/container/types.ts:81

Interface Container<T>

Remarks

Type Parameters

T

Hierarchy

Implemented by

Index

Properties

Accessors

Methods

Properties

Readonly capacity

Readonly isEmpty

Readonly isFull

Readonly isNotEmpty

Readonly isNotFull

Readonly length

Accessors

reverse

Returns Iterable<T>

Methods

[iterator]

Returns Iterator<T, any, undefined>

clear

Parameters

Optional callback: DeleteCallback<T>

Returns void

clone

Parameters

Optional callback: CloneCallback<T>

Returns Container<T>

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

Parameters

Optional separator: string

Returns string

map

Type Parameters

TO

Parameters

callback: MapCallback<T, TO>

Optional reverse: boolean

Returns TO[]

Settings

Member Visibility

Theme

`Readonly` capacity

`Readonly` isEmpty

`Readonly` isFull

`Readonly` isNotEmpty

`Readonly` isNotFull

`Readonly` length

`Optional` callback: DeleteCallback<T>

`Optional` callback: CloneCallback<T>

`Optional` callback: CompareCallback<T>

`Optional` reverse: boolean

`Optional` reverse: boolean

`Optional` reverse: boolean

`Optional` callback: CompareCallback<T>

`Optional` reverse: boolean

`Optional` separator: string

`Optional` reverse: boolean