Adapter

Properties

Property	Type
`isAsync`	`boolean`

Methods

addToRelationship()

1
addToRelationship(to: string, keys: string | string[]): Awaitable<void>

Parameters

Parameter	Type
`to`	`string`
`keys`	`string` \| `string`[]

Returns

Awaitable<void>

Source

seyfert/src/cache/adapters/types.ts:38

bulkAddToRelationShip()

1
bulkAddToRelationShip(data: Record<string, string[]>): Awaitable<void>

Parameters

Parameter	Type
`data`	`Record`<`string`, `string`[]>

Returns

Awaitable<void>

Source

seyfert/src/cache/adapters/types.ts:36

contains()

1
contains(to: string, keys: string): Awaitable<boolean>

Parameters

Parameter	Type
`to`	`string`
`keys`	`string`

Returns

Awaitable<boolean>

Source

seyfert/src/cache/adapters/types.ts:32

count()

1
count(to: string): Awaitable<number>

Parameters

Parameter	Type
`to`	`string`

Returns

Awaitable<number>

Source

seyfert/src/cache/adapters/types.ts:26

flush()

1
flush(): Awaitable<void>

Returns

Awaitable<void>

Source

seyfert/src/cache/adapters/types.ts:30

get()

get(keys)

1
get(keys: string[]): Awaitable<any[]>

Parameters

Parameter	Type
`keys`	`string`[]

Returns

Awaitable<any[]>

Source

seyfert/src/cache/adapters/types.ts:10

get(keys)

1
get(keys: string): any

Parameters

Parameter	Type
`keys`	`string`

Returns

any

Source

seyfert/src/cache/adapters/types.ts:11

get(keys)

1
get(keys: string | string[]): any

Parameters

Parameter	Type
`keys`	`string` \| `string`[]

Returns

any

Source

seyfert/src/cache/adapters/types.ts:12

getToRelationship()

1
getToRelationship(to: string): Awaitable<string[]>

Parameters

Parameter	Type
`to`	`string`

Returns

Awaitable<string[]>

Source

seyfert/src/cache/adapters/types.ts:34

keys()

1
keys(to: string): Awaitable<string[]>

Parameters

Parameter	Type
`to`	`string`

Returns

Awaitable<string[]>

Source

seyfert/src/cache/adapters/types.ts:24

patch()

patch(updateOnly, keyValue)

1
patch(updateOnly: boolean, keyValue: [string, any][]): Awaitable<void>

Parameters

Parameter	Type
`updateOnly`	`boolean`
`keyValue`	[`string`, `any`][]

Returns

Awaitable<void>

Source

seyfert/src/cache/adapters/types.ts:18

patch(updateOnly, id, data)

1
patch(
2
   updateOnly: boolean,
3
   id: string,
4
data: any): Awaitable<void>

Parameters

Parameter	Type
`updateOnly`	`boolean`
`id`	`string`
`data`	`any`

Returns

Awaitable<void>

Source

seyfert/src/cache/adapters/types.ts:19

patch(updateOnly, id, data)

1
patch(
2
   updateOnly: boolean,
3
   id: string | [string, any][],
4
data?: any): Awaitable<void>

Parameters

Parameter	Type
`updateOnly`	`boolean`
`id`	`string` \| [`string`, `any`][]
`data`?	`any`

Returns

Awaitable<void>

Source

seyfert/src/cache/adapters/types.ts:20

remove()

1
remove(keys: string | string[]): Awaitable<void>

Parameters

Parameter	Type
`keys`	`string` \| `string`[]

Returns

Awaitable<void>

Source

seyfert/src/cache/adapters/types.ts:28

removeRelationship()

1
removeRelationship(to: string | string[]): Awaitable<void>

Parameters

Parameter	Type
`to`	`string` \| `string`[]

Returns

Awaitable<void>

Source

seyfert/src/cache/adapters/types.ts:42

removeToRelationship()

1
removeToRelationship(to: string, keys: string | string[]): Awaitable<void>

Parameters

Parameter	Type
`to`	`string`
`keys`	`string` \| `string`[]

Returns

Awaitable<void>

Source

seyfert/src/cache/adapters/types.ts:40

scan()

scan(query, keys)

1
scan(query: string, keys?: false): Awaitable<any[]>

Parameters

Parameter	Type
`query`	`string`
`keys`?	`false`

Returns

Awaitable<any[]>

Source

seyfert/src/cache/adapters/types.ts:6

scan(query, keys)

1
scan(query: string, keys: true): Awaitable<string[]>

Parameters

Parameter	Type
`query`	`string`
`keys`	`true`

Returns

Awaitable<string[]>

Source

seyfert/src/cache/adapters/types.ts:7

scan(query, keys)

1
scan(query: string, keys?: boolean): Awaitable<any[]>

Parameters

Parameter	Type
`query`	`string`
`keys`?	`boolean`

Returns

Awaitable<any[]>

Source

seyfert/src/cache/adapters/types.ts:8

set()

set(keyValue)

1
set(keyValue: [string, any][]): Awaitable<void>

Parameters

Parameter	Type
`keyValue`	[`string`, `any`][]

Returns

Awaitable<void>

Source

seyfert/src/cache/adapters/types.ts:14

set(id, data)

1
set(id: string, data: any): Awaitable<void>

Parameters

Parameter	Type
`id`	`string`
`data`	`any`

Returns

Awaitable<void>

Source

seyfert/src/cache/adapters/types.ts:15

set(id, data)

1
set(id: string | [string, any][], data?: any): Awaitable<void>

Parameters

Parameter	Type
`id`	`string` \| [`string`, `any`][]
`data`?	`any`

Returns

Awaitable<void>

Source

seyfert/src/cache/adapters/types.ts:16

values()

1
values(to: string): Awaitable<any[]>

Parameters

Parameter	Type
`to`	`string`

Returns

Awaitable<any[]>

Source

seyfert/src/cache/adapters/types.ts:22