Function asIterable

Ensures an object is iterable if possible. Returns null if unable to convert to iterable.

Param: instance

Param: allowString

Returns

asIterable(instance: string): null
Ensures an object is iterable if possible. Returns null if unable to convert to iterable.
Parameters
- instance: string
Returns null
- Defined in type.ts:431
asIterable(instance: string, allowString: false): null
Ensures an object is iterable if possible. Returns null if unable to convert to iterable.
Parameters
- instance: string
- allowString: false
Returns null
- Defined in type.ts:441
asIterable(instance: string, allowString: true): string
Ensures an object is iterable if possible. Returns null if unable to convert to iterable.
Parameters
- instance: string
- allowString: true
Returns string
- Defined in type.ts:452
asIterable<T>(
instance: Iterable<T, any, any> | ArrayLike<T>,
allowString?: boolean,
): null | Iterable<T, any, any>
Ensures an object is iterable if possible. Returns null if unable to convert to iterable.
Type Parameters
- T
Parameters
- instance: Iterable<T, any, any> | ArrayLike<T>
- OptionalallowString: boolean
Returns null | Iterable<T, any, any>
- Defined in type.ts:463
asIterable<T = unknown>(
instance: unknown,
allowString?: boolean,
): null | Iterable<T, any, any>
Ensures an object is iterable if possible. Returns null if unable to convert to iterable.
Type Parameters
- T = unknown
Parameters
- instance: unknown
- OptionalallowString: boolean
Returns null | Iterable<T, any, any>
- Defined in type.ts:474