@loopback/docs 6.0.4 → 6.0.6

package/site/apidocs/repository.keyvaluerepository.get.md

@@ -1,37 +0,0 @@
----
-lang: en
-title: 'API docs: repository.keyvaluerepository.get'
-keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
-sidebar: lb4_sidebar
-editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/repository
-permalink: /doc/en/lb4/apidocs.repository.keyvaluerepository.get.html
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@loopback/repository](./repository.md) &gt; [KeyValueRepository](./repository.keyvaluerepository.md) &gt; [get](./repository.keyvaluerepository.get.md)
-
-## KeyValueRepository.get() method
-
-Get an entry by key
-
-**Signature:**
-
-```typescript
-get(key: string, options?: Options): Promise<T>;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  key | string | Key for the entry |
-|  options | [Options](./repository.options.md) | _(Optional)_ Options for the operation |
-
-**Returns:**
-
-Promise&lt;T&gt;
-
-A promise of the entry
-
-

package/site/apidocs/repository.keyvaluerepository.keys.md

@@ -1,37 +0,0 @@
----
-lang: en
-title: 'API docs: repository.keyvaluerepository.keys'
-keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
-sidebar: lb4_sidebar
-editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/repository
-permalink: /doc/en/lb4/apidocs.repository.keyvaluerepository.keys.html
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@loopback/repository](./repository.md) &gt; [KeyValueRepository](./repository.keyvaluerepository.md) &gt; [keys](./repository.keyvaluerepository.keys.md)
-
-## KeyValueRepository.keys() method
-
-Get an Iterator for matching keys
-
-**Signature:**
-
-```typescript
-keys?(filter?: KeyValueFilter, options?: Options): AsyncIterable<string>;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  filter | [KeyValueFilter](./repository.keyvaluefilter.md) | _(Optional)_ Filter for keys |
-|  options | [Options](./repository.options.md) | _(Optional)_ Options for the operation |
-
-**Returns:**
-
-AsyncIterable&lt;string&gt;
-
-An async iteratable iterator of keys so that the return value can be used with `for-await-of`<!-- -->.
-
-

package/site/apidocs/repository.keyvaluerepository.md

@@ -1,37 +0,0 @@
----
-lang: en
-title: 'API docs: repository.keyvaluerepository'
-keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
-sidebar: lb4_sidebar
-editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/repository
-permalink: /doc/en/lb4/apidocs.repository.keyvaluerepository.html
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@loopback/repository](./repository.md) &gt; [KeyValueRepository](./repository.keyvaluerepository.md)
-
-## KeyValueRepository interface
-
-Key/Value operations for connector implementations
-
-**Signature:**
-
-```typescript
-export interface KeyValueRepository<T extends Model> extends Repository<T> 
-```
-**Extends:** [Repository](./repository.repository.md)<!-- -->&lt;T&gt;
-
-## Methods
-
-|  Method | Description |
-|  --- | --- |
-|  [delete(key, options)](./repository.keyvaluerepository.delete.md) | Delete an entry by key |
-|  [deleteAll(options)](./repository.keyvaluerepository.deleteall.md) | Delete all entries |
-|  [expire(key, ttl, options)](./repository.keyvaluerepository.expire.md) | Set up ttl for an entry by key |
-|  [get(key, options)](./repository.keyvaluerepository.get.md) | Get an entry by key |
-|  [keys(filter, options)?](./repository.keyvaluerepository.keys.md) | _(Optional)_ Get an Iterator for matching keys |
-|  [set(key, value, options)](./repository.keyvaluerepository.set.md) | Set an entry with key/value |
-|  [ttl(key, options)?](./repository.keyvaluerepository.ttl.md) | _(Optional)_ Get ttl for an entry by key |
-
-

package/site/apidocs/repository.keyvaluerepository.set.md

@@ -1,36 +0,0 @@
----
-lang: en
-title: 'API docs: repository.keyvaluerepository.set'
-keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
-sidebar: lb4_sidebar
-editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/repository
-permalink: /doc/en/lb4/apidocs.repository.keyvaluerepository.set.html
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@loopback/repository](./repository.md) &gt; [KeyValueRepository](./repository.keyvaluerepository.md) &gt; [set](./repository.keyvaluerepository.set.md)
-
-## KeyValueRepository.set() method
-
-Set an entry with key/value
-
-**Signature:**
-
-```typescript
-set(key: string, value: DataObject<T>, options?: Options): Promise<void>;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  key | string | Key for the entry |
-|  value | [DataObject](./repository.dataobject.md)<!-- -->&lt;T&gt; | Value for the entry |
-|  options | [Options](./repository.options.md) | _(Optional)_ Options for the operation |
-
-**Returns:**
-
-Promise&lt;void&gt;
-
-

package/site/apidocs/repository.keyvaluerepository.ttl.md

@@ -1,37 +0,0 @@
----
-lang: en
-title: 'API docs: repository.keyvaluerepository.ttl'
-keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
-sidebar: lb4_sidebar
-editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/repository
-permalink: /doc/en/lb4/apidocs.repository.keyvaluerepository.ttl.html
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@loopback/repository](./repository.md) &gt; [KeyValueRepository](./repository.keyvaluerepository.md) &gt; [ttl](./repository.keyvaluerepository.ttl.md)
-
-## KeyValueRepository.ttl() method
-
-Get ttl for an entry by key
-
-**Signature:**
-
-```typescript
-ttl?(key: string, options?: Options): Promise<number>;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  key | string | Key for the entry |
-|  options | [Options](./repository.options.md) | _(Optional)_ Options for the operation |
-
-**Returns:**
-
-Promise&lt;number&gt;
-
-A promise of the TTL value
-
-

package/site/apidocs/repository.kvconnector.delete.md

@@ -1,38 +0,0 @@
----
-lang: en
-title: 'API docs: repository.kvconnector.delete'
-keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
-sidebar: lb4_sidebar
-editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/repository
-permalink: /doc/en/lb4/apidocs.repository.kvconnector.delete.html
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@loopback/repository](./repository.md) &gt; [KVConnector](./repository.kvconnector.md) &gt; [delete](./repository.kvconnector.delete.md)
-
-## KVConnector.delete() method
-
-Delete an entry by key
-
-**Signature:**
-
-```typescript
-delete(modelClass: Class<Entity>, key: string, options?: Options): Promise<boolean>;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  modelClass | [Class](./repository.class.md)<!-- -->&lt;[Entity](./repository.entity.md)<!-- -->&gt; | Model class |
-|  key | string | Key for the entry |
-|  options | [Options](./repository.options.md) | _(Optional)_ Options for the operation |
-
-**Returns:**
-
-Promise&lt;boolean&gt;
-
-Promise<true> if an entry is deleted for the id, otherwise Promise<false>
-
-

package/site/apidocs/repository.kvconnector.deleteall.md

@@ -1,37 +0,0 @@
----
-lang: en
-title: 'API docs: repository.kvconnector.deleteall'
-keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
-sidebar: lb4_sidebar
-editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/repository
-permalink: /doc/en/lb4/apidocs.repository.kvconnector.deleteall.html
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@loopback/repository](./repository.md) &gt; [KVConnector](./repository.kvconnector.md) &gt; [deleteAll](./repository.kvconnector.deleteall.md)
-
-## KVConnector.deleteAll() method
-
-Delete all entries
-
-**Signature:**
-
-```typescript
-deleteAll(modelClass: Class<Entity>, options?: Options): Promise<number>;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  modelClass | [Class](./repository.class.md)<!-- -->&lt;[Entity](./repository.entity.md)<!-- -->&gt; | Model class |
-|  options | [Options](./repository.options.md) | _(Optional)_ Options for the operation |
-
-**Returns:**
-
-Promise&lt;number&gt;
-
-A promise of the number of entries deleted
-
-

package/site/apidocs/repository.kvconnector.expire.md

@@ -1,39 +0,0 @@
----
-lang: en
-title: 'API docs: repository.kvconnector.expire'
-keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
-sidebar: lb4_sidebar
-editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/repository
-permalink: /doc/en/lb4/apidocs.repository.kvconnector.expire.html
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@loopback/repository](./repository.md) &gt; [KVConnector](./repository.kvconnector.md) &gt; [expire](./repository.kvconnector.expire.md)
-
-## KVConnector.expire() method
-
-Set up ttl for an entry by key
-
-**Signature:**
-
-```typescript
-expire(modelClass: Class<Entity>, key: string, ttl: number, options?: Options): Promise<boolean>;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  modelClass | [Class](./repository.class.md)<!-- -->&lt;[Entity](./repository.entity.md)<!-- -->&gt; | Model class |
-|  key | string | Key for the entry |
-|  ttl | number |  |
-|  options | [Options](./repository.options.md) | _(Optional)_ Options for the operation |
-
-**Returns:**
-
-Promise&lt;boolean&gt;
-
-Promise<true> if an entry is configured for the key, otherwise Promise<false>
-
-

package/site/apidocs/repository.kvconnector.get.md

@@ -1,38 +0,0 @@
----
-lang: en
-title: 'API docs: repository.kvconnector.get'
-keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
-sidebar: lb4_sidebar
-editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/repository
-permalink: /doc/en/lb4/apidocs.repository.kvconnector.get.html
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@loopback/repository](./repository.md) &gt; [KVConnector](./repository.kvconnector.md) &gt; [get](./repository.kvconnector.get.md)
-
-## KVConnector.get() method
-
-Get an entry by key
-
-**Signature:**
-
-```typescript
-get(modelClass: Class<Entity>, key: string, options?: Options): Promise<T>;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  modelClass | [Class](./repository.class.md)<!-- -->&lt;[Entity](./repository.entity.md)<!-- -->&gt; | Model class |
-|  key | string | Key for the entry |
-|  options | [Options](./repository.options.md) | _(Optional)_ Options for the operation |
-
-**Returns:**
-
-Promise&lt;T&gt;
-
-A promise of the entry found for the key
-
-

package/site/apidocs/repository.kvconnector.iteratekeys.md

@@ -1,38 +0,0 @@
----
-lang: en
-title: 'API docs: repository.kvconnector.iteratekeys'
-keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
-sidebar: lb4_sidebar
-editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/repository
-permalink: /doc/en/lb4/apidocs.repository.kvconnector.iteratekeys.html
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@loopback/repository](./repository.md) &gt; [KVConnector](./repository.kvconnector.md) &gt; [iterateKeys](./repository.kvconnector.iteratekeys.md)
-
-## KVConnector.iterateKeys() method
-
-Get an Iterator for matching keys
-
-**Signature:**
-
-```typescript
-iterateKeys?(modelClass: Class<Entity>, filter?: Filter, options?: Options): Promise<Iterator<T>>;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  modelClass | [Class](./repository.class.md)<!-- -->&lt;[Entity](./repository.entity.md)<!-- -->&gt; | Model class |
-|  filter | [Filter](./filter.filter.md) | _(Optional)_ Matching filter |
-|  options | [Options](./repository.options.md) | _(Optional)_ Options for the operation |
-
-**Returns:**
-
-Promise&lt;Iterator&lt;T&gt;&gt;
-
-A promise of an iterator of entries
-
-

package/site/apidocs/repository.kvconnector.keys.md

@@ -1,37 +0,0 @@
----
-lang: en
-title: 'API docs: repository.kvconnector.keys'
-keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
-sidebar: lb4_sidebar
-editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/repository
-permalink: /doc/en/lb4/apidocs.repository.kvconnector.keys.html
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@loopback/repository](./repository.md) &gt; [KVConnector](./repository.kvconnector.md) &gt; [keys](./repository.kvconnector.keys.md)
-
-## KVConnector.keys() method
-
-Fetch all keys
-
-**Signature:**
-
-```typescript
-keys?(modelClass: Class<Entity>, options?: Options): Promise<string[]>;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  modelClass | [Class](./repository.class.md)<!-- -->&lt;[Entity](./repository.entity.md)<!-- -->&gt; | Model class |
-|  options | [Options](./repository.options.md) | _(Optional)_ Options for the operation |
-
-**Returns:**
-
-Promise&lt;string\[\]&gt;
-
-A promise of an array of keys for all entries
-
-

package/site/apidocs/repository.kvconnector.md

@@ -1,38 +0,0 @@
----
-lang: en
-title: 'API docs: repository.kvconnector'
-keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
-sidebar: lb4_sidebar
-editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/repository
-permalink: /doc/en/lb4/apidocs.repository.kvconnector.html
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@loopback/repository](./repository.md) &gt; [KVConnector](./repository.kvconnector.md)
-
-## KVConnector interface
-
-Key/Value operations for connector implementations
-
-**Signature:**
-
-```typescript
-export interface KVConnector<T extends Entity> extends Connector 
-```
-**Extends:** [Connector](./repository.connector.md)
-
-## Methods
-
-|  Method | Description |
-|  --- | --- |
-|  [delete(modelClass, key, options)](./repository.kvconnector.delete.md) | Delete an entry by key |
-|  [deleteAll(modelClass, options)](./repository.kvconnector.deleteall.md) | Delete all entries |
-|  [expire(modelClass, key, ttl, options)](./repository.kvconnector.expire.md) | Set up ttl for an entry by key |
-|  [get(modelClass, key, options)](./repository.kvconnector.get.md) | Get an entry by key |
-|  [iterateKeys(modelClass, filter, options)?](./repository.kvconnector.iteratekeys.md) | _(Optional)_ Get an Iterator for matching keys |
-|  [keys(modelClass, options)?](./repository.kvconnector.keys.md) | _(Optional)_ Fetch all keys |
-|  [set(modelClass, key, value, options)](./repository.kvconnector.set.md) | Set an entry with key/value |
-|  [ttl(modelClass, key, ttl, options)?](./repository.kvconnector.ttl.md) | _(Optional)_ Get ttl for an entry by key |
-
-

package/site/apidocs/repository.kvconnector.set.md

@@ -1,39 +0,0 @@
----
-lang: en
-title: 'API docs: repository.kvconnector.set'
-keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
-sidebar: lb4_sidebar
-editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/repository
-permalink: /doc/en/lb4/apidocs.repository.kvconnector.set.html
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@loopback/repository](./repository.md) &gt; [KVConnector](./repository.kvconnector.md) &gt; [set](./repository.kvconnector.set.md)
-
-## KVConnector.set() method
-
-Set an entry with key/value
-
-**Signature:**
-
-```typescript
-set(modelClass: Class<Entity>, key: string, value: EntityData, options?: Options): Promise<boolean>;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  modelClass | [Class](./repository.class.md)<!-- -->&lt;[Entity](./repository.entity.md)<!-- -->&gt; | Model class |
-|  key | string | Key for the entry |
-|  value | [EntityData](./repository.entitydata.md) | Value for the entry |
-|  options | [Options](./repository.options.md) | _(Optional)_ Options for the operation |
-
-**Returns:**
-
-Promise&lt;boolean&gt;
-
-Promise<true> if an entry is set for the key, otherwise Promise<false>
-
-

package/site/apidocs/repository.kvconnector.ttl.md

@@ -1,39 +0,0 @@
----
-lang: en
-title: 'API docs: repository.kvconnector.ttl'
-keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
-sidebar: lb4_sidebar
-editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/repository
-permalink: /doc/en/lb4/apidocs.repository.kvconnector.ttl.html
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@loopback/repository](./repository.md) &gt; [KVConnector](./repository.kvconnector.md) &gt; [ttl](./repository.kvconnector.ttl.md)
-
-## KVConnector.ttl() method
-
-Get ttl for an entry by key
-
-**Signature:**
-
-```typescript
-ttl?(modelClass: Class<Entity>, key: string, ttl: number, options?: Options): Promise<number>;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  modelClass | [Class](./repository.class.md)<!-- -->&lt;[Entity](./repository.entity.md)<!-- -->&gt; | Model class |
-|  key | string | Key for the entry |
-|  ttl | number | Time to live in millisenconds |
-|  options | [Options](./repository.options.md) | _(Optional)_ Options for the operation |
-
-**Returns:**
-
-Promise&lt;number&gt;
-
-A promise of the TTL value
-
-