Skip to content

Latest commit

 

History

History
609 lines (335 loc) · 13.6 KB

class.FlowsService.md

File metadata and controls

609 lines (335 loc) · 13.6 KB

directus-monorepo ( Readme | API )


directus-monorepo > FlowsService

Class: FlowsService

Extends

Constructors

constructor()

new FlowsService(options): FlowsService

Parameters

Parameter Type
options AbstractServiceOptions

Returns

FlowsService

Overrides

ItemsService.constructor

Source

api/src/services/flows.ts:7

Properties

accountability

accountability: any

Source

api/src/services/items.ts:43

Inherited from

ItemsService.accountability


cache

cache: null | Keyv< any, Record< string, unknown > >

Source

api/src/services/items.ts:46

Inherited from

ItemsService.cache


collection

collection: string

Source

api/src/services/items.ts:41

Inherited from

ItemsService.collection


eventScope

eventScope: string

Source

api/src/services/items.ts:44

Inherited from

ItemsService.eventScope


knex

knex: Knex< any, any[] >

Source

api/src/services/items.ts:42

Inherited from

ItemsService.knex


schema

schema: SchemaOverview

Source

api/src/services/items.ts:45

Inherited from

ItemsService.schema

Methods

createMany()

createMany(data, opts?): Promise< PrimaryKey[] >

Create multiple new items at once. Inserts all provided records sequentially wrapped in a transaction.

Parameters

Parameter Type
data Partial< Item >[]
opts? MutationOptions

Returns

Promise< PrimaryKey[] >

Overrides

ItemsService.createMany

Source

api/src/services/flows.ts:20


createMutationTracker()

createMutationTracker(initialCount = 0): MutationTracker

Parameters

Parameter Type Default value
initialCount number 0

Returns

MutationTracker

Inherited from

ItemsService.createMutationTracker

Source

api/src/services/items.ts:59


createOne()

createOne(data, opts?): Promise< PrimaryKey >

Create a single new item.

Parameters

Parameter Type
data Partial< Item >
opts? MutationOptions

Returns

Promise< PrimaryKey >

Overrides

ItemsService.createOne

Source

api/src/services/flows.ts:11


deleteByQuery()

deleteByQuery(query, opts?): Promise< PrimaryKey[] >

Delete multiple items by query

Parameters

Parameter Type
query Query
opts? MutationOptions

Returns

Promise< PrimaryKey[] >

Inherited from

ItemsService.deleteByQuery

Source

api/src/services/items.ts:859


deleteMany()

deleteMany(keys, opts?): Promise< PrimaryKey[] >

Delete multiple items by primary key

Parameters

Parameter Type
keys PrimaryKey[]
opts? MutationOptions

Returns

Promise< PrimaryKey[] >

Overrides

ItemsService.deleteMany

Source

api/src/services/flows.ts:47


deleteOne()

deleteOne(key, opts?): Promise< PrimaryKey >

Delete a single item by primary key

Parameters

Parameter Type
key PrimaryKey
opts? MutationOptions

Returns

Promise< PrimaryKey >

Inherited from

ItemsService.deleteOne

Source

api/src/services/items.ts:871


getKeysByQuery()

getKeysByQuery(query): Promise< PrimaryKey[] >

Parameters

Parameter Type
query Query

Returns

Promise< PrimaryKey[] >

Inherited from

ItemsService.getKeysByQuery

Source

api/src/services/items.ts:76


readByQuery()

readByQuery(query, opts?): Promise< FlowRaw[] >

Get items by query

Parameters

Parameter Type
query Query
opts? QueryOptions

Returns

Promise< FlowRaw[] >

Inherited from

ItemsService.readByQuery

Source

api/src/services/items.ts:395


readMany()

readMany( keys, query = {}, opts?): Promise< FlowRaw[] >

Get multiple items by primary keys

Parameters

Parameter Type
keys PrimaryKey[]
query Query
opts? QueryOptions

Returns

Promise< FlowRaw[] >

Inherited from

ItemsService.readMany

Source

api/src/services/items.ts:501


readOne()

readOne( key, query = {}, opts?): Promise< FlowRaw >

Get single item by primary key

Parameters

Parameter Type
key PrimaryKey
query Query
opts? QueryOptions

Returns

Promise< FlowRaw >

Inherited from

ItemsService.readOne

Source

api/src/services/items.ts:482


readSingleton()

readSingleton(query, opts?): Promise< FlowRaw >

Read/treat collection as singleton

Parameters

Parameter Type
query Query
opts? QueryOptions

Returns

Promise< FlowRaw >

Inherited from

ItemsService.readSingleton

Source

api/src/services/items.ts:982


updateBatch()

updateBatch(data, opts?): Promise< PrimaryKey[] >

Update multiple items in a single transaction

Parameters

Parameter Type
data Partial< Item >[]
opts? MutationOptions

Returns

Promise< PrimaryKey[] >

Overrides

ItemsService.updateBatch

Source

api/src/services/flows.ts:29


updateByQuery()

updateByQuery( query, data, opts?): Promise< PrimaryKey[] >

Update multiple items by query

Parameters

Parameter Type
query Query
data FlowRaw
opts? MutationOptions

Returns

Promise< PrimaryKey[] >

Inherited from

ItemsService.updateByQuery

Source

api/src/services/items.ts:521


updateMany()

updateMany( keys, data, opts?): Promise< PrimaryKey[] >

Update many items by primary key, setting all items to the same change

Parameters

Parameter Type
keys PrimaryKey[]
data Partial< Item >
opts? MutationOptions

Returns

Promise< PrimaryKey[] >

Overrides

ItemsService.updateMany

Source

api/src/services/flows.ts:38


updateOne()

updateOne( key, data, opts?): Promise< PrimaryKey >

Update a single item by primary key

Parameters

Parameter Type
key PrimaryKey
data FlowRaw
opts? MutationOptions

Returns

Promise< PrimaryKey >

Inherited from

ItemsService.updateOne

Source

api/src/services/items.ts:533


upsertMany()

upsertMany(payloads, opts = {}): Promise< PrimaryKey[] >

Upsert many items

Parameters

Parameter Type
payloads FlowRaw[]
opts MutationOptions

Returns

Promise< PrimaryKey[] >

Inherited from

ItemsService.upsertMany

Source

api/src/services/items.ts:829


upsertOne()

upsertOne(payload, opts?): Promise< PrimaryKey >

Upsert a single item

Parameters

Parameter Type
payload FlowRaw
opts? MutationOptions

Returns

Promise< PrimaryKey >

Inherited from

ItemsService.upsertOne

Source

api/src/services/items.ts:803


upsertSingleton()

upsertSingleton(data, opts?): Promise< PrimaryKey >

Upsert/treat collection as singleton

Parameters

Parameter Type
data FlowRaw
opts? MutationOptions

Returns

Promise< PrimaryKey >

Inherited from

ItemsService.upsertSingleton

Source

api/src/services/items.ts:1018


Generated using TypeDoc and typedoc-plugin-markdown