Iterable | @rcsb/rcsb-saguaro-3d

The Iterable is a set of (key, value) entries which can be iterated, and is the base class for all collections in immutable, allowing them to make use of all the Iterable methods (such as map and filter).

Note: An iterable is always iterated in the same order, however that order may not always be well defined, as is the case for the Map and Set.

Index

Namespaces

Interfaces

Functions

Indexed

Indexed<T>(iter: <internal>.Indexed<T>): <internal>.Indexed<T>
Indexed<T>(iter: <internal>.Set<T>): <internal>.Indexed<T>
Indexed<K, V>(iter: <internal>.Keyed<K, V>): <internal>.Indexed<any>
Indexed<T>(array: T[]): <internal>.Indexed<T>
Indexed<T>(iterator: Iterator<T>): <internal>.Indexed<T>
Indexed<T>(iterable: <internal>.Object): <internal>.Indexed<T>

- Defined in node_modules/molstar/node_modules/immutable/dist/immutable-nonambient.d.ts:1495
Creates a new Iterable.Indexed.

Type parameters
- T
Parameters
- iter: <internal>.Indexed<T>
Returns <internal>.Indexed<T>
- Defined in node_modules/molstar/node_modules/immutable/dist/immutable-nonambient.d.ts:1496
Type parameters
- T
Parameters
- iter: <internal>.Set<T>
Returns <internal>.Indexed<T>
- Defined in node_modules/molstar/node_modules/immutable/dist/immutable-nonambient.d.ts:1497
Type parameters
- K
- V
Parameters
- iter: <internal>.Keyed<K, V>
Returns <internal>.Indexed<any>
- Defined in node_modules/molstar/node_modules/immutable/dist/immutable-nonambient.d.ts:1498
Type parameters
- T
Parameters
- array: T[]
Returns <internal>.Indexed<T>
- Defined in node_modules/molstar/node_modules/immutable/dist/immutable-nonambient.d.ts:1499
Type parameters
- T
Parameters
- iterator: Iterator<T>
Returns <internal>.Indexed<T>
- Defined in node_modules/molstar/node_modules/immutable/dist/immutable-nonambient.d.ts:1500
Type parameters
- T
Parameters
- iterable: <internal>.Object
Returns <internal>.Indexed<T>

Keyed

Keyed<K, V>(iter: <internal>.Keyed<K, V>): <internal>.Keyed<K, V>
Keyed<K, V>(iter: <internal>.Iterable<any, any>): <internal>.Keyed<K, V>
Keyed<K, V>(array: any[]): <internal>.Keyed<K, V>
Keyed<V>(obj: {}): <internal>.Keyed<string, V>
Keyed<K, V>(iterator: Iterator<any>): <internal>.Keyed<K, V>
Keyed<K, V>(iterable: <internal>.Object): <internal>.Keyed<K, V>

- Defined in node_modules/molstar/node_modules/immutable/dist/immutable-nonambient.d.ts:1414
Creates an Iterable.Keyed

Similar to Iterable(), however it expects iterable-likes of [K, V] tuples if not constructed from a Iterable.Keyed or JS Object.

Type parameters
- K
- V
Parameters
- iter: <internal>.Keyed<K, V>
Returns <internal>.Keyed<K, V>
- Defined in node_modules/molstar/node_modules/immutable/dist/immutable-nonambient.d.ts:1415
Type parameters
- K
- V
Parameters
- iter: <internal>.Iterable<any, any>
Returns <internal>.Keyed<K, V>
- Defined in node_modules/molstar/node_modules/immutable/dist/immutable-nonambient.d.ts:1416
Type parameters
- K
- V
Parameters
- array: any[]
Returns <internal>.Keyed<K, V>
- Defined in node_modules/molstar/node_modules/immutable/dist/immutable-nonambient.d.ts:1417
Type parameters
- V
Parameters
- obj: {}
  - [key: string]: V
Returns <internal>.Keyed<string, V>
- Defined in node_modules/molstar/node_modules/immutable/dist/immutable-nonambient.d.ts:1418
Type parameters
- K
- V
Parameters
- iterator: Iterator<any>
Returns <internal>.Keyed<K, V>
- Defined in node_modules/molstar/node_modules/immutable/dist/immutable-nonambient.d.ts:1419
Type parameters
- K
- V
Parameters
- iterable: <internal>.Object
Returns <internal>.Keyed<K, V>

Set

Set<T>(iter: <internal>.Set<T>): <internal>.Set<T>
Set<T>(iter: <internal>.Indexed<T>): <internal>.Set<T>
Set<K, V>(iter: <internal>.Keyed<K, V>): <internal>.Set<any>
Set<T>(array: T[]): <internal>.Set<T>
Set<T>(iterator: Iterator<T>): <internal>.Set<T>
Set<T>(iterable: <internal>.Object): <internal>.Set<T>

- Defined in node_modules/molstar/node_modules/immutable/dist/immutable-nonambient.d.ts:1665
Similar to Iterable(), but always returns a Iterable.Set.

Type parameters
- T
Parameters
- iter: <internal>.Set<T>
Returns <internal>.Set<T>
- Defined in node_modules/molstar/node_modules/immutable/dist/immutable-nonambient.d.ts:1666
Type parameters
- T
Parameters
- iter: <internal>.Indexed<T>
Returns <internal>.Set<T>
- Defined in node_modules/molstar/node_modules/immutable/dist/immutable-nonambient.d.ts:1667
Type parameters
- K
- V
Parameters
- iter: <internal>.Keyed<K, V>
Returns <internal>.Set<any>
- Defined in node_modules/molstar/node_modules/immutable/dist/immutable-nonambient.d.ts:1668
Type parameters
- T
Parameters
- array: T[]
Returns <internal>.Set<T>
- Defined in node_modules/molstar/node_modules/immutable/dist/immutable-nonambient.d.ts:1669
Type parameters
- T
Parameters
- iterator: Iterator<T>
Returns <internal>.Set<T>
- Defined in node_modules/molstar/node_modules/immutable/dist/immutable-nonambient.d.ts:1670
Type parameters
- T
Parameters
- iterable: <internal>.Object
Returns <internal>.Set<T>

isAssociative

isAssociative(maybeAssociative: any): boolean

- Defined in node_modules/molstar/node_modules/immutable/dist/immutable-nonambient.d.ts:1390
True if maybeAssociative is either a keyed or indexed Iterable.

Parameters
- maybeAssociative: any
Returns boolean

isIndexed

isIndexed(maybeIndexed: any): boolean

- Defined in node_modules/molstar/node_modules/immutable/dist/immutable-nonambient.d.ts:1385
True if maybeIndexed is a Iterable.Indexed, or any of its subclasses.

Parameters
- maybeIndexed: any
Returns boolean

isIterable

isIterable(maybeIterable: any): boolean

- Defined in node_modules/molstar/node_modules/immutable/dist/immutable-nonambient.d.ts:1375
True if maybeIterable is an Iterable, or any of its subclasses.

Parameters
- maybeIterable: any
Returns boolean

isKeyed

isKeyed(maybeKeyed: any): boolean

- Defined in node_modules/molstar/node_modules/immutable/dist/immutable-nonambient.d.ts:1380
True if maybeKeyed is an Iterable.Keyed, or any of its subclasses.

Parameters
- maybeKeyed: any
Returns boolean

isOrdered

isOrdered(maybeOrdered: any): boolean

- Defined in node_modules/molstar/node_modules/immutable/dist/immutable-nonambient.d.ts:1396
True if maybeOrdered is an Iterable where iteration order is well defined. True for Iterable.Indexed as well as OrderedMap and OrderedSet.

Parameters
- maybeOrdered: any
Returns boolean

Index

Namespaces

Interfaces

Functions

Functions

Indexed

Type parameters

T

Parameters

iter: <internal>.Indexed<T>

Returns <internal>.Indexed<T>

Type parameters

T

Parameters

iter: <internal>.Set<T>

Returns <internal>.Indexed<T>

Type parameters

K

V

Parameters

iter: <internal>.Keyed<K, V>

Returns <internal>.Indexed<any>

Type parameters

T

Parameters

array: T[]

Returns <internal>.Indexed<T>

Type parameters

T

Parameters

iterator: Iterator<T>

Returns <internal>.Indexed<T>

Type parameters

T

Parameters

iterable: <internal>.Object

Returns <internal>.Indexed<T>

Keyed

Type parameters

K

V

Parameters

iter: <internal>.Keyed<K, V>

Returns <internal>.Keyed<K, V>

Type parameters

K

V

Parameters

iter: <internal>.Iterable<any, any>

Returns <internal>.Keyed<K, V>

Type parameters

K

V

Parameters

array: any[]

Returns <internal>.Keyed<K, V>

Type parameters

V

Parameters

obj: {}

[key: string]: V

Returns <internal>.Keyed<string, V>

Type parameters

K

V

Parameters

iterator: Iterator<any>

Returns <internal>.Keyed<K, V>

Type parameters

K

V

Parameters

iterable: <internal>.Object

Returns <internal>.Keyed<K, V>

Set

Type parameters

T

Parameters

iter: <internal>.Set<T>

Returns <internal>.Set<T>