Interface ItemsApi<T>

interface ItemsApi<T> {
    collectionName?: string;
    createItem(item: T): Promise<T>;
    deleteItem(id: string): Promise<boolean>;
    getItem(id: string): Promise<T>;
    getItems(): Promise<T[]>;
    updateItem(item: Partial<T>): Promise<T>;
}

Type Parameters

T

Index

Properties

collectionName?

Methods

createItem? deleteItem? getItem? getItems updateItem?

Properties

`Optional`collectionName

collectionName?: string

Methods

`Optional`createItem

createItem(item: T): Promise<T>
Parameters
- item: T
Returns Promise<T>
- Defined in src/types/ItemsApi.d.ts:7

`Optional`deleteItem

deleteItem(id: string): Promise<boolean>
Parameters
- id: string
Returns Promise<boolean>
- Defined in src/types/ItemsApi.d.ts:9

`Optional`getItem

getItem(id: string): Promise<T>
Parameters
- id: string
Returns Promise<T>
- Defined in src/types/ItemsApi.d.ts:6

getItems

getItems(): Promise<T[]>
Returns Promise<T[]>
- Defined in src/types/ItemsApi.d.ts:5

`Optional`updateItem

updateItem(item: Partial<T>): Promise<T>
Parameters
- item: Partial<T>
Returns Promise<T>
- Defined in src/types/ItemsApi.d.ts:8