@ti-platform/aide v3.5.0
@ti-platform/aide
This package exposes some types and functions as utilities that can be used by other packages. Refer to the below API Docs for more information.
Contents
- API Docs
- Classes
- Interfaces
- Type Aliases
- AnyArray\
- Awaitable\
- BiConsumer()\<T, U>
- BiMapper()\<T, U, R>
- BinaryOperator()\
- BiPredicate()\<T, U>
- Consumer()\
- Mapper()\<T, R>
- MapPlusKey
- MarkReadonly\<T, K>
- Merge\<T, U>
- NonEmptyArray\
- Predicate()\
- QueueItem()\
- Runnable()
- Simplify\
- SimplifyOmit\<T, K>
- Supplier()\
- TernaryOperator()\
- TriConsumer()\<T, U, V>
- TriMapper()\<T, U, V, R>
- TriPredicate()\<T, U, V>
- UnaryOperator()\
- UndefinedFallback\<T, Fallback>
- Functions
API Docs
Classes
Deferred\
Extracting out a Promise's resolve and reject method to allow one to more easily pass around those methods.
Type Parameters
| Type Parameter | Default type | Description |
|---|---|---|
T | void | The type to resolve with. |
Constructors
new Deferred()
new Deferred<
T>():Deferred<T>
Create a new instance.
Returns
Deferred<T>
Defined in
packages/aide/src/promises.ts:37
Properties
| Property | Modifier | Type | Description |
|---|---|---|---|
promise | readonly | Promise<T> | The underlying promise. |
reject | public | (reason?: any) => void | Reject the internal promise. |
resolve | public | (value: Awaitable<T>) => void | Resolves the internal promise. |
MapPlus\<K, V>
Extension to a Map with some new methods.
Extends
Map<K,V>
Type Parameters
| Type Parameter |
|---|
K extends MapPlusKey |
V |
Constructors
new MapPlus()
new MapPlus<
K,V>(entries?):MapPlus<K,V>
Parameters
| Parameter | Type |
|---|---|
entries? | null | readonly readonly [K, V][] |
Returns
MapPlus<K, V>
Inherited from
Map<K, V>.constructor
Defined in
common/temp/node_modules/.pnpm/typescript\@5.6.3/node_modules/typescript/lib/lib.es2015.collection.d.ts:50
new MapPlus()
new MapPlus<
K,V>(iterable?):MapPlus<K,V>
Parameters
| Parameter | Type |
|---|---|
iterable? | null | Iterable\<readonly [K, V], any, any> |
Returns
MapPlus<K, V>
Inherited from
Map<K, V>.constructor
Defined in
common/temp/node_modules/.pnpm/typescript\@5.6.3/node_modules/typescript/lib/lib.es2015.collection.d.ts:49
Properties
| Property | Modifier | Type | Description | Inherited from |
|---|---|---|---|---|
[toStringTag] | readonly | string | - | Map.[toStringTag] |
size | readonly | number | Map.size | |
[species] | readonly | MapConstructor | - | Map.[species] |
Methods
[iterator]()
[iterator]():
MapIterator<[K,V]>
Returns an iterable of entries in the map.
Returns
MapIterator<[K, V]>
Inherited from
Map.[iterator]
Defined in
common/temp/node_modules/.pnpm/typescript\@5.6.3/node_modules/typescript/lib/lib.es2015.iterable.d.ts:143
asOptional()
asOptional(
key):Optional<V>
Retrieve the value for the provided key as an Optional.
Parameters
| Parameter | Type |
|---|---|
key | K |
Returns
Optional<V>
Defined in
packages/aide/src/map.ts:53
clear()
clear():
void
Returns
void
Inherited from
Map.clear
Defined in
common/temp/node_modules/.pnpm/typescript\@5.6.3/node_modules/typescript/lib/lib.es2015.collection.d.ts:20
clearAndReturn()
clearAndReturn():
this
Same as Map#clear but returns this instance after clearing.
Returns
this
Defined in
packages/aide/src/map.ts:60
compute()
compute(
key,remapper):Optional<V>
Attempts to compute a mapping for the specified key and its current mapped value, or undefined if there is no current mapping. If the remapping function returns undefined or null, the mapping is removed (or remains absent if initially absent).
Parameters
| Parameter | Type |
|---|---|
key | K |
remapper | Mapper<{key: K;map: MapPlus<K, V>;value: undefined | V; }, Optional<V>> |
Returns
Optional<V>
An optional containing the value associated with the provided key.
Defined in
packages/aide/src/map.ts:72
computeIfAbsent()
computeIfAbsent(
key,mapper):Optional<V>
If the value for the specified key is absent, attempts to compute its value using the given mapping function and enters it into this map unless undefined or null.
Parameters
| Parameter | Type |
|---|---|
key | K |
mapper | Mapper<{key: K;map: MapPlus<K, V>; }, Optional<V>> |
Returns
Optional<V>
An optional containing the value associated with the provided key.
Defined in
packages/aide/src/map.ts:86
computeIfPresent()
computeIfPresent(
key,remapper):Optional<V>
If the value for the specified key is present, attempts to compute a new mapping given the key and its current mapped value. If the remapping function returns undefined or null, the mapping is removed.
Parameters
| Parameter | Type |
|---|---|
key | K |
remapper | Mapper<{key: K;map: MapPlus<K, V>;value: NonNullable<V>; }, Optional<V>> |
Returns
Optional<V>
An optional containing the value associated with the provided key.
Defined in
packages/aide/src/map.ts:103
contains()
contains(
item):boolean
Returns true if this map maps one or more keys to the specified value.
Parameters
| Parameter | Type |
|---|---|
item | V |
Returns
boolean
Defined in
packages/aide/src/map.ts:114
delete()
delete(
key):boolean
Parameters
| Parameter | Type |
|---|---|
key | K |
Returns
boolean
true if an element in the Map existed and has been removed, or false if the element does not exist.
Inherited from
Map.delete
Defined in
common/temp/node_modules/.pnpm/typescript\@5.6.3/node_modules/typescript/lib/lib.es2015.collection.d.ts:24
each()
each(
consumer):this
Similar to Map#forEach except return this at the end and the consumer retrieves the data differently.
Parameters
| Parameter | Type |
|---|---|
consumer | Consumer<{key: K;map: MapPlus<K, V>;value: NonNullable<V>; }> |
Returns
this
Defined in
packages/aide/src/map.ts:121
entries()
entries():
MapIterator<[K,V]>
Returns an iterable of key, value pairs for every entry in the map.
Returns
MapIterator<[K, V]>
Inherited from
Map.entries
Defined in
common/temp/node_modules/.pnpm/typescript\@5.6.3/node_modules/typescript/lib/lib.es2015.iterable.d.ts:148
entriesAsArray()
entriesAsArray(): [
K,V][]
Get the entries as an array.
Returns
[K, V][]
Defined in
packages/aide/src/map.ts:129
every()
every(
predicate):boolean
Returns true if every entry in this map satisfies the given predicate.
Parameters
| Parameter | Type |
|---|---|
predicate | Predicate<{key: K;map: MapPlus<K, V>;value: NonNullable<V>; }> |
Returns
boolean
Defined in
packages/aide/src/map.ts:136
filter()
filter(
predicate):MapPlus<K,V>
Create a new map by only keeping the entries that satisfies the provided predicate.
Parameters
| Parameter | Type |
|---|---|
predicate | Predicate<{key: K;map: MapPlus<K, V>;value: NonNullable<V>; }> |
Returns
MapPlus<K, V>
Defined in
packages/aide/src/map.ts:145
find()
find(
predicate):Optional<V>
Get an optional for the first value that matches the given predicate.
Parameters
| Parameter | Type |
|---|---|
predicate | Predicate<{key: K;map: MapPlus<K, V>;value: NonNullable<V>; }> |
Returns
Optional<V>
Defined in
packages/aide/src/map.ts:156
forEach()
forEach(
callbackfn,thisArg?):void
Executes a provided function once per each key/value pair in the Map, in insertion order.
Parameters
| Parameter | Type |
|---|---|
callbackfn | (value, key, map) => void |
thisArg? | any |
Returns
void
Inherited from
Map.forEach
Defined in
common/temp/node_modules/.pnpm/typescript\@5.6.3/node_modules/typescript/lib/lib.es2015.collection.d.ts:28
get()
get(
key):undefined|V
Returns a specified element from the Map object. If the value that is associated to the provided key is an object, then you will get a reference to that object and any change made to that object will effectively modify it inside the Map.
Parameters
| Parameter | Type |
|---|---|
key | K |
Returns
undefined | V
Returns the element associated with the specified key. If no element is associated with the specified key, undefined is returned.
Inherited from
Map.get
Defined in
common/temp/node_modules/.pnpm/typescript\@5.6.3/node_modules/typescript/lib/lib.es2015.collection.d.ts:33
getOrDefault()
getOrDefault(
key,defaultValue):V
If this map has the provided key, return the value associated with that key, otherwise return the provided default value.
Parameters
| Parameter | Type |
|---|---|
key | K |
defaultValue | V |
Returns
V
Defined in
packages/aide/src/map.ts:166
getOrThrow()
getOrThrow(
key):NonNullable<V>
Similar to Map#get but will throw an Error if the key does not exist.
Parameters
| Parameter | Type |
|---|---|
key | K |
Returns
NonNullable<V>
Defined in
packages/aide/src/map.ts:173
has()
has(
key):boolean
Parameters
| Parameter | Type |
|---|---|
key | K |
Returns
boolean
boolean indicating whether an element with the specified key exists or not.
Inherited from
Map.has
Defined in
common/temp/node_modules/.pnpm/typescript\@5.6.3/node_modules/typescript/lib/lib.es2015.collection.d.ts:37
isEmpty()
isEmpty():
boolean
Returns true if this map contains no key-value mappings.
Returns
boolean
Defined in
packages/aide/src/map.ts:184
keys()
keys():
MapIterator<K>
Returns an iterable of keys in the map
Returns
MapIterator<K>
Inherited from
Map.keys
Defined in
common/temp/node_modules/.pnpm/typescript\@5.6.3/node_modules/typescript/lib/lib.es2015.iterable.d.ts:153
keysArray()
keysArray():
K[]
Retrieve the keys as an array.
Returns
K[]
Defined in
packages/aide/src/map.ts:191
mapKeys()
mapKeys<
R>(mapper):MapPlus<R,V>
Create a new version of this map with the keys mapped to a different value with the provided mapper. Please note that no consideration will be made in validate the keys are not duplicated meaning if the mapper function generates the same key multiple times, the later will override the previous value.
Type Parameters
| Type Parameter |
|---|
R extends MapPlusKey |
Parameters
| Parameter | Type |
|---|---|
mapper | Mapper<{key: K;map: MapPlus<K, V>;value: NonNullable<V>; }, R> |
Returns
MapPlus<R, V>
Defined in
packages/aide/src/map.ts:200
mapValues()
mapValues<
R>(mapper):MapPlus<K,R>
Create a new version of this map with the values mapped to a different value with the provided mapper.
Type Parameters
| Type Parameter |
|---|
R |
Parameters
| Parameter | Type |
|---|---|
mapper | Mapper<{key: K;map: MapPlus<K, V>;value: NonNullable<V>; }, R> |
Returns
MapPlus<K, R>
Defined in
packages/aide/src/map.ts:212
set()
set(
key,value):this
Adds a new element with a specified key and value to the Map. If an element with the same key already exists, the element will be updated.
Parameters
| Parameter | Type |
|---|---|
key | K |
value | V |
Returns
this
Inherited from
Map.set
Defined in
common/temp/node_modules/.pnpm/typescript\@5.6.3/node_modules/typescript/lib/lib.es2015.collection.d.ts:41
setAll()
setAll(
map):this
Set all key/value pair in the given map to this map.
Parameters
| Parameter | Type |
|---|---|
map | Map<K, V> | Record<K, V> | [K, V][] |
Returns
this
Defined in
packages/aide/src/map.ts:224
setIfAbsent()
setIfAbsent(
key,value):V
Set the provided value to the provided key if it doesn't exists, returning the new current value.
Parameters
| Parameter | Type |
|---|---|
key | K |
value | V |
Returns
V
Defined in
packages/aide/src/map.ts:239
some()
some(
predicate):boolean
Returns true if at least one entry in this map satisfies the provided predicate.
Parameters
| Parameter | Type |
|---|---|
predicate | Predicate<{key: K;map: MapPlus<K, V>;value: NonNullable<V>; }> |
Returns
boolean
Defined in
packages/aide/src/map.ts:251
toObject()
toObject<
K2,V2>(__namedParameters):Record<K2,V2>
Convert this to an object of key/value pair with possibility of mapping the key and value.
Type Parameters
| Type Parameter |
|---|
K2 extends MapPlusKey |
V2 |
Parameters
| Parameter | Type |
|---|---|
__namedParameters | object |
__namedParameters.keyMapper? | Mapper<{key: K;map: MapPlus<K, V>;value: NonNullable<V>; }, K2> |
__namedParameters.valueMapper? | Mapper<{key: K;map: MapPlus<K, V>;value: NonNullable<V>; }, V2> |
Returns
Record<K2, V2>
Defined in
packages/aide/src/map.ts:260
values()
values():
MapIterator<V>
Returns an iterable of values in the map
Returns
MapIterator<V>
Inherited from
Map.values
Defined in
common/temp/node_modules/.pnpm/typescript\@5.6.3/node_modules/typescript/lib/lib.es2015.iterable.d.ts:158
valuesArray()
valuesArray():
V[]
Retrieves all values as an array.
Returns
V[]
Defined in
packages/aide/src/map.ts:281
groupBy()
staticgroupBy<K,T>(items,keySelector):Map<K,T[]>
Groups members of an iterable according to the return value of the passed callback.
Type Parameters
| Type Parameter |
|---|
K |
T |
Parameters
| Parameter | Type | Description |
|---|---|---|
items | Iterable<T, any, any> | An iterable. |
keySelector | (item, index) => K | A callback which will be invoked for each item in items. |
Returns
Map<K, T[]>
Inherited from
Map.groupBy
Defined in
common/temp/node_modules/.pnpm/typescript\@5.6.3/node_modules/typescript/lib/lib.esnext.collection.d.ts:25
Queue\
Queue that execute handlers as per the configured concurrency limit. It also has the ability to rate limit how much execution happens within an interval.
Type Parameters
| Type Parameter | Default type | Description |
|---|---|---|
T | void | The type of the item that the promise resolves with for the handlers. Defaults to void. |
Constructors
new Queue()
new Queue<
T>(__namedParameters):Queue<T>
Create a new instance.
Parameters
| Parameter | Type | Description |
|---|---|---|
__namedParameters | object | - |
__namedParameters.intervalMs? | number | If given in addition with maxPerInterval, used to limit how many items can execute within an interval. This is simply the time, in milliseconds, for when to reset the execution counts per interval. |
__namedParameters.maxConcurrent | number | Maximum number of concurrent executions. |
__namedParameters.maxPerInterval? | number | If given in addition with intervalMs, used to limit how many items can execute within an interval. This is simply the maximum number of executions within the interval. |
Returns
Queue<T>
Defined in
packages/aide/src/queue.ts:146
Properties
| Property | Modifier | Type | Description |
|---|---|---|---|
intervalMs | readonly | number | If given in addition with maxPerInterval, used to limit how many items can execute within an interval. This is simply the time, in milliseconds, for when to reset the execution counts per interval. |
maxConcurrent | readonly | number | Maximum number of concurrent executions. |
maxPerInterval | readonly | number | If given in addition with intervalMs, used to limit how many items can execute within an interval. This is simply the maximum number of executions within the interval. |
Methods
add()
add(
item): {onAfterStart:Promise<void>;onBeforeStart:Promise<void>;onEnd:Promise<T>; }
Add a new item to the queue for execution.
Parameters
| Parameter | Type |
|---|---|
item | QueueItem<T> |
Returns
{onAfterStart: Promise<void>;onBeforeStart: Promise<void>;onEnd: Promise<T>; }
| Name | Type | Description |
|---|---|---|
onAfterStart | Promise<void> | Promised that is resolved right after the handler is executed but not necessarily after it has finished execution. |
onBeforeStart | Promise<void> | Promised that is resolved right before the handler is executed. |
onEnd | Promise<T> | Promised that is resolved after the handler finished executing. |
Throws
Error if items can no longer be added.
Defined in
packages/aide/src/queue.ts:157
lockQueue()
lockQueue():
Promise<void>
Lock the queue and return a promise that will resolve when all the handlers finished execution.
Returns
Promise<void>
Defined in
packages/aide/src/queue.ts:181
Interfaces
Optional\
Wrapper around values that are either present or absent (null or undefined).
Type Parameters
| Type Parameter |
|---|
T |
Methods
filter()
filter(
predicate):Optional<T>
If a value is present and the value matches the given predicate, return an Optional describing the value, otherwise return an empty Optional.
Parameters
| Parameter | Type |
|---|---|
predicate | Predicate<NonNullable<T>> |
Returns
Optional<T>
Defined in
packages/aide/src/optional.ts:11
flatMap()
flatMap<
R>(mapper):Optional<R>
If a value is present, apply the provided Optional-bearing mapping function to it, return that result, otherwise return an empty Optional. This method is similar to map, but the provided mapper is one whose result is already an Optional, and if invoked, flatMap does not wrap it with an additional Optional.
Type Parameters
| Type Parameter |
|---|
R |
Parameters
| Parameter | Type |
|---|---|
mapper | Mapper<NonNullable<T>, Optional<R>> |
Returns
Optional<R>
Defined in
packages/aide/src/optional.ts:18
getOrThrow()
getOrThrow():
NonNullable<T>
If the value is present, returns the value, otherwise throws an Error.
Returns
NonNullable<T>
Defined in
packages/aide/src/optional.ts:23
ifAbsent()
ifAbsent(
handler):this
If the value is absent, invoke the specified handler, otherwise do nothing.
Parameters
| Parameter | Type |
|---|---|
handler | Runnable |
Returns
this
Defined in
packages/aide/src/optional.ts:28
ifPresent()
ifPresent(
consumer):this
If a value is present, invoke the specified consumer with the value, otherwise do nothing.
Parameters
| Parameter | Type |
|---|---|
consumer | Consumer<NonNullable<T>> |
Returns
this
Defined in
packages/aide/src/optional.ts:33
isAbsent()
isAbsent():
boolean
If a value is absent (null or undefined), returns true, otherwise false.
Returns
boolean
Defined in
packages/aide/src/optional.ts:38
isPresent()
isPresent():
boolean
If a value is present, returns true, otherwise false.
Returns
boolean
Defined in
packages/aide/src/optional.ts:43
map()
map<
R>(mapper):Optional<R>
If a value is present, apply the provided mapping function to it, and if the result is present, return an Optional describing the result, otherwise, return an empty Optional.
Type Parameters
| Type Parameter |
|---|
R |
Parameters
| Parameter | Type |
|---|---|
mapper | Mapper<NonNullable<T>, R> |
Returns
Optional<R>
Defined in
packages/aide/src/optional.ts:49
or()
or(
other):Optional<T>
If a value is present, returns an Optional describing the value, otherwise returns an Optional produced by the supplying function.
Parameters
| Parameter | Type |
|---|---|
other | Supplier<Optional<T>> |
Returns
Optional<T>
Defined in
packages/aide/src/optional.ts:55
orElse()
orElse(
other):T
If a value is present, returns the value, otherwise returns other.
Parameters
| Parameter | Type |
|---|---|
other | T |
Returns
T
Defined in
packages/aide/src/optional.ts:60
orElseGet()
orElseGet(
other):T
If a value is present, returns the value, otherwise returns the result produced by the supplying function.
Parameters
| Parameter | Type |
|---|---|
other | Supplier<T> |
Returns
T
Defined in
packages/aide/src/optional.ts:65
orElseThrow()
orElseThrow<
X>(other):T
If a value is present, returns the value, otherwise throws an exception to be created by the provided supplier.
Type Parameters
| Type Parameter |
|---|
X |
Parameters
| Parameter | Type |
|---|---|
other | Supplier<X> |
Returns
T
Defined in
packages/aide/src/optional.ts:70
orUndefined()
orUndefined():
undefined|NonNullable<T>
If a value is present, returns the value, otherwise return undefined.
Returns
undefined | NonNullable<T>
Defined in
packages/aide/src/optional.ts:75
QueueConstructorOptions
Arguments for constructing a Queue.
Properties
| Property | Type | Description |
|---|---|---|
intervalMs? | number | If given in addition with maxPerInterval, used to limit how many items can execute within an interval. This is simply the time, in milliseconds, for when to reset the execution counts per interval. |
maxConcurrent | number | Maximum number of concurrent executions. |
maxPerInterval? | number | If given in addition with intervalMs, used to limit how many items can execute within an interval. This is simply the maximum number of executions within the interval. |
Type Aliases
AnyArray\
AnyArray<
V>:V[] |ReadonlyArray<V>
Type matching against both a writable array and a readonly array.
Type Parameters
| Type Parameter | Description |
|---|---|
V | The type of each item in the array. |
Defined in
packages/aide/src/types.ts:11
Awaitable\
Awaitable<
T>:T|Promise<T>
The type is simply T or a promise which, when resolved, is given T.
Type Parameters
| Type Parameter |
|---|
T |
Defined in
packages/aide/src/types.ts:4
BiConsumer()\<T, U>
BiConsumer<
T,U>: (t,u) =>void
Represents an operation that accepts two input arguments and returns no result.
Type Parameters
| Type Parameter |
|---|
T |
U |
Parameters
| Parameter | Type |
|---|---|
t | T |
u | U |
Returns
void
Defined in
packages/aide/src/function.ts:4
BiMapper()\<T, U, R>
BiMapper<
T,U,R>: (t,u) =>R
Represents a function that accepts two arguments and produces a result.
Type Parameters
| Type Parameter |
|---|
T |
U |
R |
Parameters
| Parameter | Type |
|---|---|
t | T |
u | U |
Returns
R
Defined in
packages/aide/src/function.ts:9
BinaryOperator()\
BinaryOperator<
T>: (left,right) =>T
Represents an operation upon two operands of the same type, producing a result of the same type as the operands.
Type Parameters
| Type Parameter |
|---|
T |
Parameters
| Parameter | Type |
|---|---|
left | T |
right | T |
Returns
T
Defined in
packages/aide/src/function.ts:14
BiPredicate()\<T, U>
BiPredicate<
T,U>: (t,u) =>boolean
Represents a predicate (boolean-valued function) of two arguments.
Type Parameters
| Type Parameter |
|---|
T |
U |
Parameters
| Parameter | Type |
|---|---|
t | T |
u | U |
Returns
boolean
Defined in
packages/aide/src/function.ts:19
Consumer()\
Consumer<
T>: (t) =>void
Represents an operation that accepts a single input argument and returns no result.
Type Parameters
| Type Parameter |
|---|
T |
Parameters
| Parameter | Type |
|---|---|
t | T |
Returns
void
Defined in
packages/aide/src/function.ts:24
Mapper()\<T, R>
Mapper<
T,R>: (t) =>R
Represents a function that accepts one argument and produces a result.
Type Parameters
| Type Parameter |
|---|
T |
R |
Parameters
| Parameter | Type |
|---|---|
t | T |
Returns
R
Defined in
packages/aide/src/function.ts:29
MapPlusKey
MapPlusKey:
string|number|symbol
The possible type for a key.
Defined in
packages/aide/src/map.ts:20
MarkReadonly\<T, K>
MarkReadonly<
T,K>:Omit<T,K> &Readonly<Pick<T,K>>
For a given object, T, mark the keys given as being readonly.
Type Parameters
| Type Parameter |
|---|
T |
K extends keyof T |
Defined in
packages/aide/src/types.ts:16
Merge\<T, U>
Merge<
T,U>:Simplify<Omit<T, keyofU> &U>
Merge the two types together with the properties from second type overwriting the first.
Type Parameters
| Type Parameter |
|---|
T |
U |
Defined in
packages/aide/src/types.ts:21
NonEmptyArray\
NonEmptyArray<
T>: [T,...T[]]
For a non-empty array.
Type Parameters
| Type Parameter |
|---|
T |
Defined in
packages/aide/src/types.ts:26
Predicate()\
Predicate<
T>: (t) =>boolean
Represents a predicate (boolean-valued function) of one argument.
Type Parameters
| Type Parameter |
|---|
T |
Parameters
| Parameter | Type |
|---|---|
t | T |
Returns
boolean
Defined in
packages/aide/src/function.ts:39
QueueItem()\
QueueItem<
T>: () =>Awaitable<T>
An item in the queue.
Type Parameters
| Type Parameter | Default type | Description |
|---|---|---|
T | void | The type of the item that the promise resolves with. Defaults to void. |
Returns
Awaitable<T>
Defined in
packages/aide/src/queue.ts:28
Runnable()
Runnable: () =>
void
Represents a runnable task that takes no arguments and returns no result.
Returns
void
Defined in
packages/aide/src/function.ts:34
Simplify\
Simplify<
T>:{ [KeyType in keyof T]: T[KeyType] }&NonNullable<unknown>
Refer to https://github.com/sindresorhus/type-fest/blob/main/source/simplify.d.ts.
Type Parameters
| Type Parameter |
|---|
T |
Defined in
packages/aide/src/types.ts:31
SimplifyOmit\<T, K>
SimplifyOmit<
T,K>:Simplify<Omit<T,K>>
Wrapping Simplify over Omit.
Type Parameters
| Type Parameter |
|---|
T |
K extends keyof T |
Defined in
packages/aide/src/types.ts:36
Supplier()\
Supplier<
T>: () =>T
Represents a supplier of results.
Type Parameters
| Type Parameter |
|---|
T |
Returns
T
Defined in
packages/aide/src/function.ts:44
TernaryOperator()\
TernaryOperator<
T>: (first,second,third) =>T
Represents an operation upon three operands of the same type, producing a result of the same type as the operands.
Type Parameters
| Type Parameter |
|---|
T |
Parameters
| Parameter | Type |
|---|---|
first | T |
second | T |
third | T |
Returns
T
Defined in
packages/aide/src/function.ts:49
TriConsumer()\<T, U, V>
TriConsumer<
T,U,V>: (t,u,v) =>void
Represents an operation that accepts three input arguments and returns no result.
Type Parameters
| Type Parameter |
|---|
T |
U |
V |
Parameters
| Parameter | Type |
|---|---|
t | T |
u | U |
v | V |
Returns
void
Defined in
packages/aide/src/function.ts:54
TriMapper()\<T, U, V, R>
TriMapper<
T,U,V,R>: (t,u,v) =>R
Represents a function that accepts three arguments and produces a result.
Type Parameters
| Type Parameter |
|---|
T |
U |
V |
R |
Parameters
| Parameter | Type |
|---|---|
t | T |
u | U |
v | V |
Returns
R
Defined in
packages/aide/src/function.ts:59
TriPredicate()\<T, U, V>
TriPredicate<
T,U,V>: (t,u,v) =>boolean
Represents a predicate (boolean-valued function) of three arguments.
Type Parameters
| Type Parameter |
|---|
T |
U |
V |
Parameters
| Parameter | Type |
|---|---|
t | T |
u | U |
v | V |
Returns
boolean
Defined in
packages/aide/src/function.ts:64
UnaryOperator()\
UnaryOperator<
T>: (t) =>T
Represents an operation on a single operand that produces a result of the same type as its operand.
Type Parameters
| Type Parameter |
|---|
T |
Parameters
| Parameter | Type |
|---|---|
t | T |
Returns
T
Defined in
packages/aide/src/function.ts:69
UndefinedFallback\<T, Fallback>
UndefinedFallback<
T,Fallback>: [T] extends [undefined] ?Fallback:T
If the given type, T is undefined, return Fallback, otherwise just return `T.
Type Parameters
| Type Parameter |
|---|
T |
Fallback |
Defined in
packages/aide/src/types.ts:40
Functions
createOptional()
createOptional<
T>(value):Optional<T>
Create an optional from the provided value.
Type Parameters
| Type Parameter |
|---|
T |
Parameters
| Parameter | Type | Default value |
|---|---|---|
value | undefined | null | T | undefined |
Returns
Optional<T>
Defined in
packages/aide/src/optional.ts:195
ensureType()
ensureType<
V>(): <T>(list) => readonlyT[]
This function is primarily here to help with stricter typing. When Typescript allows for partial inference of arguments to functions, this function would likely not be needed anymore.
Type Parameters
| Type Parameter | Description |
|---|---|
V | The type of each item in the array. |
Returns
Function
An identity function that accepts a list and simply returns it.
Type Parameters
| Type Parameter |
|---|
T |
Parameters
| Parameter | Type |
|---|---|
list | readonly T[] |
Returns
readonly T[]
Example
type MyItem = { name: string, displayName: string };
const list = ensureType<MyItem>()([
{ name: 'one', displayName: 'ONE' }, // <- You get proper linting and hinting support here
{ name: 'two', displayName: 'TWO' },
] as const); // <- The "as const" allows for better type restrictions as below
type Name = typeof list[number]['name']; // == "one" | "two" vs string if not using thisDefined in
packages/aide/src/arrays.ts:21
executeTasks()
executeTasks<
T>(tasks,maxNumOfWorkers):Promise<T[]>
Given a list of tasks to execute, execute them, ensuring there is a maximum number of tasks actively running at the same time. The returning array of responses should match the order of the task that was given.
Type Parameters
| Type Parameter | Description |
|---|---|
T | The type of the result of each task. |
Parameters
| Parameter | Type | Default value | Description |
|---|---|---|---|
tasks | readonly () => Promise<T>[] | undefined | The tasks to run. |
maxNumOfWorkers | number | 10 | The maximum number of tasks to run at once. |
Returns
Promise<T[]>
A promise that will resolve when all the tasks are completed.
Defined in
packages/aide/src/queue.ts:13
first()
first<
V>(list):V|undefined
Retrieve the first value in the given list or undefined if it is empty.
Type Parameters
| Type Parameter |
|---|
V |
Parameters
| Parameter | Type |
|---|---|
list | AnyArray<V> |
Returns
V | undefined
Defined in
packages/aide/src/arrays.ts:30
firstDefined()
firstDefined<
V>(list):V|undefined
Execute the functions in the list and return the value of the first supplier that return a defined value.
Type Parameters
| Type Parameter |
|---|
V |
Parameters
| Parameter | Type |
|---|---|
list | AnyArray<Supplier<undefined | V>> |
Returns
V | undefined
Defined in
packages/aide/src/arrays.ts:44
firstDefinedOpt()
firstDefinedOpt<
V>(list):Optional<V>
Same as firstDefined except both the supplier and the return value of this should be an Optional.
Type Parameters
| Type Parameter |
|---|
V |
Parameters
| Parameter | Type |
|---|---|
list | AnyArray<Supplier<Optional<V>>> |
Returns
Optional<V>
Defined in
packages/aide/src/arrays.ts:51
firstOpt()
firstOpt<
V>(list):Optional<V>
Same as first except this returns an Optional.
Type Parameters
| Type Parameter |
|---|
V |
Parameters
| Parameter | Type |
|---|---|
list | AnyArray<V> |
Returns
Optional<V>
Defined in
packages/aide/src/arrays.ts:37
getOrDefault()
getOrDefault<
K,V>(map,key,defaultValue):V
Type Parameters
| Type Parameter | Description |
|---|---|
K | The type of the key in the map. |
V | The type of the value in the map. |
Parameters
| Parameter | Type | Description |
|---|---|---|
map | Map<K, V> | The map to get the data from. |
key | K | The key to get the data for. |
defaultValue | V | The default value to return if the key does not exist. |
Returns
V
The value in the map with the given key or if the key does not exist, the provided default value.
Defined in
packages/aide/src/map.ts:13
keepOnlyDefined()
keepOnlyDefined<
V>(list):NonNullable<V>[]
Given a list of items, remove null and undefined from the list.
Type Parameters
| Type Parameter |
|---|
V |
Parameters
| Parameter | Type |
|---|---|
list | AnyArray<V> |
Returns
NonNullable<V>[]
Defined in
packages/aide/src/arrays.ts:64
toMap()
toMap<
K,V,V2>(list,keySupplier,valueSupplier):Record<K,V2>
Given a list, convert it to an object where the key will be provided using the given supplier.
Type Parameters
| Type Parameter | Description |
|---|---|
K extends PropertyKey | The type for the key that will be produced for the map. |
V | The type of each item in the list. |
V2 | The type for the value when it is set to the map. |
Parameters
| Parameter | Type | Description |
|---|---|---|
list | AnyArray<V> | The list of items to convert. |
keySupplier | BiMapper<V, number, K> | Function to use to generate the key for each entry. |
valueSupplier | TriMapper<V, K, number, V2> | Function to use to generate the value for each entry. |
Returns
Record<K, V2>
An object representation of the given list using the provided suppliers to generate the keys and values.
Defined in
packages/aide/src/arrays.ts:79
toMapPlus()
toMapPlus<
K,V>(from):MapPlus<K,V>
Ensure the given is a MapPlus.
Type Parameters
| Type Parameter |
|---|
K extends MapPlusKey |
V |
Parameters
| Parameter | Type |
|---|---|
from | Map<K, V> | Record<K, V> | [K, V][] |
Returns
MapPlus<K, V>
Defined in
packages/aide/src/map.ts:35
waitFor()
waitFor(
timeMs):Promise<void>
Returns a promise which will resolve after the provided time.
Parameters
| Parameter | Type |
|---|---|
timeMs | number |
Returns
Promise<void>
Defined in
packages/aide/src/promises.ts:6
4 months ago
8 months ago
8 months ago
9 months ago
11 months ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago