directus-monorepo ( Readme | API )
directus-monorepo > FoldersService
new FoldersService(
options):FoldersService
| Parameter | Type |
|---|---|
options |
AbstractServiceOptions |
accountability:
any
cache:
null|Keyv<any,Record<string,unknown> >
collection:
string
eventScope:
string
knex:
Knex<any,any[] >
schema:
SchemaOverview
createMany(
data,opts={}):Promise<PrimaryKey[] >
Create multiple new items at once. Inserts all provided records sequentially wrapped in a transaction.
| Parameter | Type |
|---|---|
data |
Partial< Item >[] |
opts |
MutationOptions |
Promise< PrimaryKey[] >
createMutationTracker(
initialCount=0):MutationTracker
| Parameter | Type | Default value |
|---|---|---|
initialCount |
number |
0 |
ItemsService.createMutationTracker
createOne(
data,opts={}):Promise<PrimaryKey>
Create a single new item.
| Parameter | Type |
|---|---|
data |
Partial< Item > |
opts |
MutationOptions |
Promise< PrimaryKey >
deleteByQuery(
query,opts?):Promise<PrimaryKey[] >
Delete multiple items by query
| Parameter | Type |
|---|---|
query |
Query |
opts? |
MutationOptions |
Promise< PrimaryKey[] >
deleteMany(
keys,opts={}):Promise<PrimaryKey[] >
Delete multiple items by primary key
| Parameter | Type |
|---|---|
keys |
PrimaryKey[] |
opts |
MutationOptions |
Promise< PrimaryKey[] >
deleteOne(
key,opts?):Promise<PrimaryKey>
Delete a single item by primary key
| Parameter | Type |
|---|---|
key |
PrimaryKey |
opts? |
MutationOptions |
Promise< PrimaryKey >
getKeysByQuery(
query):Promise<PrimaryKey[] >
| Parameter | Type |
|---|---|
query |
Query |
Promise< PrimaryKey[] >
readByQuery(
query,opts?):Promise<Item[] >
Get items by query
| Parameter | Type |
|---|---|
query |
Query |
opts? |
QueryOptions |
Promise< Item[] >
readMany(
keys,query={},opts?):Promise<Item[] >
Get multiple items by primary keys
| Parameter | Type |
|---|---|
keys |
PrimaryKey[] |
query |
Query |
opts? |
QueryOptions |
Promise< Item[] >
readOne(
key,query={},opts?):Promise<Item>
Get single item by primary key
| Parameter | Type |
|---|---|
key |
PrimaryKey |
query |
Query |
opts? |
QueryOptions |
Promise< Item >
readSingleton(
query,opts?):Promise<Partial<Item> >
Read/treat collection as singleton
| Parameter | Type |
|---|---|
query |
Query |
opts? |
QueryOptions |
Promise< Partial< Item > >
updateBatch(
data,opts={}):Promise<PrimaryKey[] >
Update multiple items in a single transaction
| Parameter | Type |
|---|---|
data |
Partial< Item >[] |
opts |
MutationOptions |
Promise< PrimaryKey[] >
updateByQuery(
query,data,opts?):Promise<PrimaryKey[] >
Update multiple items by query
| Parameter | Type |
|---|---|
query |
Query |
data |
Partial< Item > |
opts? |
MutationOptions |
Promise< PrimaryKey[] >
updateMany(
keys,data,opts={}):Promise<PrimaryKey[] >
Update many items by primary key, setting all items to the same change
| Parameter | Type |
|---|---|
keys |
PrimaryKey[] |
data |
Partial< Item > |
opts |
MutationOptions |
Promise< PrimaryKey[] >
updateOne(
key,data,opts?):Promise<PrimaryKey>
Update a single item by primary key
| Parameter | Type |
|---|---|
key |
PrimaryKey |
data |
Partial< Item > |
opts? |
MutationOptions |
Promise< PrimaryKey >
upsertMany(
payloads,opts={}):Promise<PrimaryKey[] >
Upsert many items
| Parameter | Type |
|---|---|
payloads |
Partial< Item >[] |
opts |
MutationOptions |
Promise< PrimaryKey[] >
upsertOne(
payload,opts?):Promise<PrimaryKey>
Upsert a single item
| Parameter | Type |
|---|---|
payload |
Partial< Item > |
opts? |
MutationOptions |
Promise< PrimaryKey >
upsertSingleton(
data,opts?):Promise<PrimaryKey>
Upsert/treat collection as singleton
| Parameter | Type |
|---|---|
data |
Partial< Item > |
opts? |
MutationOptions |
Promise< PrimaryKey >
api/src/services/items.ts:1018
Generated using TypeDoc and typedoc-plugin-markdown