@sms/plugin-collections
Interfaces
CollectionFieldContribution
Defined in: packages/plugins/collections/src/contract.ts:23
Properties
collection
collection: string;
Defined in: packages/plugins/collections/src/contract.ts:24
field
field: Field;
Defined in: packages/plugins/collections/src/contract.ts:25
CollectionHook
Defined in: packages/plugins/collections/src/contract.ts:30
Properties
collection
collection: string;
Defined in: packages/plugins/collections/src/contract.ts:31
handler
handler: (record, previous?) => unknown;
Defined in: packages/plugins/collections/src/contract.ts:33
Parameters
| Parameter | Type |
|---|---|
record | Record<string, unknown> |
previous? | Record<string, unknown> |
Returns
unknown
on
on: HookEvent;
Defined in: packages/plugins/collections/src/contract.ts:32
CollectionSchema
Defined in: packages/plugins/collections/src/contract.ts:17
Properties
description?
optional description?: string;
Defined in: packages/plugins/collections/src/contract.ts:19
fields
fields: Field[];
Defined in: packages/plugins/collections/src/contract.ts:20
name
name: string;
Defined in: packages/plugins/collections/src/contract.ts:18
CollectionsService
Defined in: packages/plugins/collections/src/contract.ts:38
Methods
create()
create(name, data): Promise<Record<string, unknown>>;
Defined in: packages/plugins/collections/src/contract.ts:46
Parameters
| Parameter | Type |
|---|---|
name | string |
data | Record<string, unknown> |
Returns
Promise<Record<string, unknown>>
get()
get(name, id): Promise<Record<string, unknown> | undefined>;
Defined in: packages/plugins/collections/src/contract.ts:45
Parameters
| Parameter | Type |
|---|---|
name | string |
id | number |
Returns
Promise<Record<string, unknown> | undefined>
list()
list(name, opts?): Promise<Record<string, unknown>[]>;
Defined in: packages/plugins/collections/src/contract.ts:41
Parameters
| Parameter | Type |
|---|---|
name | string |
opts? | { desc?: boolean; limit?: number; orderBy?: string; where?: Record<string, unknown>; } |
opts.desc? | boolean |
opts.limit? | number |
opts.orderBy? | string |
opts.where? | Record<string, unknown> |
Returns
Promise<Record<string, unknown>[]>
names()
names(): string[];
Defined in: packages/plugins/collections/src/contract.ts:39
Returns
string[]
remove()
remove(name, id): Promise<boolean>;
Defined in: packages/plugins/collections/src/contract.ts:48
Parameters
| Parameter | Type |
|---|---|
name | string |
id | number |
Returns
Promise<boolean>
schema()
schema(name): CollectionSchema | undefined;
Defined in: packages/plugins/collections/src/contract.ts:40
Parameters
| Parameter | Type |
|---|---|
name | string |
Returns
CollectionSchema | undefined
update()
update(
name,
id,
data
): Promise<Record<string, unknown>>;
Defined in: packages/plugins/collections/src/contract.ts:47
Parameters
| Parameter | Type |
|---|---|
name | string |
id | number |
data | Record<string, unknown> |
Returns
Promise<Record<string, unknown>>
Field
Defined in: packages/plugins/collections/src/contract.ts:9
Properties
default?
optional default?: unknown;
Defined in: packages/plugins/collections/src/contract.ts:13
description?
optional description?: string;
Defined in: packages/plugins/collections/src/contract.ts:14
name
name: string;
Defined in: packages/plugins/collections/src/contract.ts:10
required?
optional required?: boolean;
Defined in: packages/plugins/collections/src/contract.ts:12
type
type: FieldType;
Defined in: packages/plugins/collections/src/contract.ts:11
Type Aliases
FieldType
type FieldType = "text" | "integer" | "real" | "boolean" | "json";
Defined in: packages/plugins/collections/src/contract.ts:7
HookEvent
type HookEvent = "create" | "update" | "remove";
Defined in: packages/plugins/collections/src/contract.ts:28
Record_
type Record_ = Record<string, unknown>;
Defined in: packages/plugins/collections/src/contract.ts:36
Variables
COLLECTION_FIELD_POINT
const COLLECTION_FIELD_POINT: "collection-field" = 'collection-field';
Defined in: packages/plugins/collections/src/contract.ts:53
COLLECTION_HOOK_POINT
const COLLECTION_HOOK_POINT: "collection-hook" = 'collection-hook';
Defined in: packages/plugins/collections/src/contract.ts:54
COLLECTION_POINT
const COLLECTION_POINT: "collection" = 'collection';
Defined in: packages/plugins/collections/src/contract.ts:52
COLLECTIONS_KEY
const COLLECTIONS_KEY: "collections" = 'collections';
Defined in: packages/plugins/collections/src/contract.ts:51
collectionsPlugin
const collectionsPlugin: SystemPlugin;
Defined in: packages/plugins/collections/src/index.ts:30
Functions
validateField()
function validateField(f): asserts f is Field;
Defined in: packages/plugins/collections/src/contract.ts:59
Parameters
| Parameter | Type |
|---|---|
f | unknown |
Returns
asserts f is Field
validateSchema()
function validateSchema(s): asserts s is CollectionSchema;
Defined in: packages/plugins/collections/src/contract.ts:68
Parameters
| Parameter | Type |
|---|---|
s | unknown |
Returns
asserts s is CollectionSchema
References
Contribution
Re-exports Contribution