ApiKeys
Defined in: domain/ApiKeys.ts:17
Represents a collection of API key entities for a specific project.
Remarks
Use ApiKeys.getInstance to retrieve an instance of this collection for a given project.
Example
const apiKeys = await ApiKeys.getInstance(101);
const allKeys = apiKeys.getItems();
Extends
DeletableCollection<ApiKey,number>
Constructors
Constructor
new ApiKeys(transform): ApiKeys;
Defined in: domain/DeletableCollection.ts:40
Constructs a new DeletableCollection.
Parameters
transform
Optional function to transform raw API data to entity type T.
null | (data) => ApiKey
Returns
ApiKeys
Inherited from
DeletableCollection.constructor
Accessors
length
Get Signature
get length(): number;
Defined in: domain/DomainCollection.ts:214
The number of items in the collection.
Returns
number
The item count.
Inherited from
Methods
[iterator]()
iterator: Iterator<ApiKey>;
Defined in: domain/DomainCollection.ts:228
Iterator support for for...of loops.
Returns
Iterator<ApiKey>
Example
for (const item of collection) {
console.log(item);
}
Inherited from
DeletableCollection.[iterator]
create()
create(item): Promise<ApiKey>;
Defined in: domain/UpdatableCollection.ts:46
Creates a new item in the collection and adds it locally.
Parameters
item
The item to create.
Returns
Promise<ApiKey>
A promise that resolves to the created item.
Throws
If an item with the same ID already exists.
Inherited from
delete()
delete(id): Promise<boolean>;
Defined in: domain/DeletableCollection.ts:86
Soft-deletes an item in the collection by its ID.
Parameters
id
number
The ID of the item to delete.
Returns
Promise<boolean>
A promise that resolves to true if the item was found and marked as deleted, false otherwise.
Inherited from
findById()
findById(id): undefined | ApiKey;
Defined in: domain/DomainCollection.ts:186
Finds an item in the collection by its ID.
Parameters
id
number
The unique identifier of the item.
Returns
undefined | ApiKey
The found item, or undefined if not found.
Inherited from
forEach()
forEach(callback): void;
Defined in: domain/DomainCollection.ts:244
Executes a provided function once for each item in the collection.
Parameters
callback
(item, index, collection) => void
Function to execute for each item.
Returns
void
Example
collection.forEach((item, idx) => {
console.log(idx, item);
});
Inherited from
get()
get(index): undefined | ApiKey;
Defined in: domain/DomainCollection.ts:205
Gets the item at the specified index.
Parameters
index
number
The zero-based index of the item.
Returns
undefined | ApiKey
The item at the given index, or undefined if out of bounds.
Inherited from
getItems()
getItems(showDeleted): ApiKey[];
Defined in: domain/DeletableCollection.ts:121
Gets items in the collection, optionally filtering by deletion status.
Parameters
showDeleted
TrueFalseOnly = TrueFalseOnly.False
Controls which items are returned:
- TrueFalseOnly.False (default): Only non-deleted items.
- TrueFalseOnly.Only: Only deleted items.
- TrueFalseOnly.True: All items.
Returns
ApiKey[]
An array of items matching the filter.
Inherited from
map()
map<R>(fn): R[];
Defined in: domain/DomainCollection.ts:254
Creates a new array populated with the results of calling a provided function on every item.
Type Parameters
R
R
Parameters
fn
(item, index, collection) => R
Function that produces an element of the new array.
Returns
R[]
A new array with each element being the result of the callback function.
Inherited from
refresh()
refresh(): Promise<void>;
Defined in: domain/DeletableCollection.ts:48
Refreshes the collection by fetching items from the API, including deleted items.
Returns
Promise<void>
A promise that resolves when the items are loaded.
Inherited from
toArray()
toArray(): ApiKey[];
Defined in: domain/DomainCollection.ts:263
Returns a shallow copy of all items as a plain array.
Returns
ApiKey[]
A new array containing the same items.
Inherited from
undelete()
undelete(id): Promise<boolean>;
Defined in: domain/DeletableCollection.ts:102
Restores a previously deleted item in the collection by its ID.
Parameters
id
number
The ID of the item to restore.
Returns
Promise<boolean>
A promise that resolves to true if the item was found and restored, false otherwise.
Inherited from
update()
update(update): Promise<null | ApiKey>;
Defined in: domain/UpdatableCollection.ts:68
Updates an existing item in the collection.
Parameters
update
The updated item.
Returns
Promise<null | ApiKey>
A promise that resolves to the updated item, or null if not found.
Inherited from
getCollection()
static getCollection<T, U, Self>(this, transform): Self & {
[n: number]: undefined | T;
length: number;
};
Defined in: domain/DomainCollection.ts:83
Static factory to create a proxied, array-like collection instance.
The returned proxy enables:
- Numeric index access (
collection[0]) - Iteration (
for...of) - Length property (
collection.length)
Type Parameters
T
T extends Id<U>
U
U
Self
Self extends DomainCollection<T, U>
Parameters
this
(transform) => Self
The concrete subclass constructor.
transform
Optional function to transform raw API data into entities.
null | (data) => T
Returns
Self & {
[n: number]: undefined | T;
length: number;
}
A proxied DomainCollection with array-like behavior.
Example
const orgs = Organisations.create();
console.log(orgs.length); // behaves like an array
console.log(orgs[0]); // index access
Inherited from
DeletableCollection.getCollection
getInstance()
static getInstance(project_id?): Promise<ApiKeys>;
Defined in: domain/ApiKeys.ts:28
Retrieves an instance of the ApiKeys collection for the specified project.
Parameters
project_id?
number
The ID of the project whose API keys to retrieve.
Returns
Promise<ApiKeys>
A promise that resolves to an ApiKeys instance.