Function asIterable

asIterable(instance: string): null
Ensures an object is iterable if possible. Returns null if unable to convert to iterable.

Returns
Parameters
- instance: string
Returns null
- Defined in type.ts:433
asIterable(instance: string, allowString: false): null
Ensures an object is iterable if possible. Returns null if unable to convert to iterable.

Returns
Parameters
- instance: string
- allowString: false
Returns null
- Defined in type.ts:443
asIterable(instance: string, allowString: true): string
Ensures an object is iterable if possible. Returns null if unable to convert to iterable.

Returns
Parameters
- instance: string
- allowString: true
Returns string
- Defined in type.ts:454
asIterable<T>(instance: Iterable<T> | ArrayLike<T>, allowString?: boolean): Iterable<T> | null
Ensures an object is iterable if possible. Returns null if unable to convert to iterable.

Returns
Type Parameters
- T
Parameters
- instance: Iterable<T> | ArrayLike<T>
- Optional allowString: boolean
Returns Iterable<T> | null
- Defined in type.ts:465
asIterable<T>(instance: unknown, allowString?: boolean): Iterable<T> | null
Ensures an object is iterable if possible. Returns null if unable to convert to iterable.

Returns
Type Parameters
- T = unknown
Parameters
- instance: unknown
- Optional allowString: boolean
Returns Iterable<T> | null
- Defined in type.ts:476

Generated using TypeDoc