class.FilesService.md

directus-monorepo ( Readme | API )

---

directus-monorepo > FilesService

Class: FilesService

Extends

• ItemsService

Constructors

constructor()

new FilesService(options): FilesService

Parameters

Parameter	Type
options	AbstractServiceOptions

Returns

FilesService

Overrides

ItemsService.constructor

Source

api/src/services/files.ts:32

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[] >

Inherited from

ItemsService.createMany

Source

api/src/services/items.ts:337

---

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 file (only applicable when it is not a multipart/data POST request) Useful for associating metadata with existing file in storage

Parameters

Parameter	Type
data	File
opts?	MutationOptions

Returns

Promise< PrimaryKey >

Overrides

ItemsService.createOne

Source

api/src/services/files.ts:311

---

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): Promise< PrimaryKey[] >

Delete multiple files

Parameters

Parameter	Type
keys	PrimaryKey[]

Returns

Promise< PrimaryKey[] >

Overrides

ItemsService.deleteMany

Source

api/src/services/files.ts:331

---

deleteOne()

deleteOne(key): Promise< PrimaryKey >

Delete a file

Parameters

Parameter	Type
key	PrimaryKey

Returns

Promise< PrimaryKey >

Overrides

ItemsService.deleteOne

Source

api/src/services/files.ts:323

---

getKeysByQuery()

getKeysByQuery(query): Promise< PrimaryKey[] >

Parameters

Parameter	Type
query	Query

Returns

Promise< PrimaryKey[] >

Inherited from

ItemsService.getKeysByQuery

Source

api/src/services/items.ts:76

---

getMetadata()

getMetadata(stream, allowList = ...): Promise< Partial< Pick< File, "height" | "width" | "description" | "title" | "tags" | "metadata" > > >

Extract metadata from a buffer's content

Parameters

Parameter	Type
stream	Readable
allowList	any

Returns

Promise< Partial< Pick< File, "height" | "width" | "description" | "title" | "tags" | "metadata" > > >

Source

api/src/services/files.ts:148

---

importOne()

importOne(importURL, body): Promise< PrimaryKey >

Import a single file from an external URL

Parameters

Parameter	Type
importURL	string
body	File

Returns

Promise< PrimaryKey >

Source

api/src/services/files.ts:267

---

readByQuery()

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

Get items by query

Parameters

Parameter	Type
query	Query
opts?	QueryOptions

Returns

Promise< Item[] >

Inherited from

ItemsService.readByQuery

Source

api/src/services/items.ts:395

---

readMany()

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

Get multiple items by primary keys

Parameters

Parameter	Type
keys	PrimaryKey[]
query	Query
opts?	QueryOptions

Returns

Promise< Item[] >

Inherited from

ItemsService.readMany

Source

api/src/services/items.ts:501

---

readOne()

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

Get single item by primary key

Parameters

Parameter	Type
key	PrimaryKey
query	Query
opts?	QueryOptions

Returns

Promise< Item >

Inherited from

ItemsService.readOne

Source

api/src/services/items.ts:482

---

readSingleton()

readSingleton(query, opts?): Promise< Partial< Item > >

Read/treat collection as singleton

Parameters

Parameter	Type
query	Query
opts?	QueryOptions

Returns

Promise< Partial< Item > >

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[] >

Inherited from

ItemsService.updateBatch

Source

api/src/services/items.ts:544

---

updateByQuery()

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

Update multiple items by query

Parameters

Parameter	Type
query	Query
data	Partial< Item >
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[] >

Inherited from

ItemsService.updateMany

Source

api/src/services/items.ts:581

---

updateOne()

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

Update a single item by primary key

Parameters

Parameter	Type
key	PrimaryKey
data	Partial< Item >
opts?	MutationOptions

Returns

Promise< PrimaryKey >

Inherited from

ItemsService.updateOne

Source

api/src/services/items.ts:533

---

uploadOne()

uploadOne( stream, data, primaryKey?, opts?): Promise< PrimaryKey >

Upload a single new file to the configured storage adapter

Parameters

Parameter	Type
stream	Readable
data	any
primaryKey?	PrimaryKey
opts?	MutationOptions

Returns

Promise< PrimaryKey >

Source

api/src/services/files.ts:39

---

upsertMany()

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

Upsert many items

Parameters

Parameter	Type
payloads	Partial< Item >[]
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	Partial< Item >
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	Partial< Item >
opts?	MutationOptions

Returns

Promise< PrimaryKey >

Inherited from

ItemsService.upsertSingleton

Source

api/src/services/items.ts:1018

---

Generated using TypeDoc and typedoc-plugin-markdown