Directus / @directus/sdk / rest / readFiles

Function: readFiles() ​

readFiles<Schema, TQuery>(query?): RestCommand<IfAny<Schema, Record<string, any>, Merge<MappedFunctionFields<Schema, UnpackList<IfAny<Schema, Object, "directus_files" extends keyof Schema ? UnpackList<...> extends Item ? ... & ... : never : Object>>> extends FF ? MapFlatFields<UnpackList<IfAny<Schema, Object, "directus_files" extends keyof Schema ? UnpackList<...> extends Item ? ... & ... : never : Object>>, FieldsWildcard<UnpackList<IfAny<Schema, Object, "directus_files" extends keyof ... ? ... extends ... ? ... : ... : Object>>, Exclude<UnpackList<Mutable<...[...]>>, PickRelationalFields<UnpackList<...>> extends never ? never : AllKeys<... extends ... ? ... : ...>>>, FF extends Record<string, string> ? FF<FF> : Record<string, string>> : never, PickRelationalFields<UnpackList<Mutable<TQuery["fields"]>>> extends never ? never : { [Field in string | number | symbol]: Field extends keyof UnpackList<IfAny<Schema, Object, (...) extends (...) ? (...) : (...)>> ? Extract<UnpackList<(...)>[Field<(...)>], ItemType<Schema>> extends RelatedCollection ? IsNullable<UnpackList<(...)>[Field<(...)>], null | ((...) extends (...) ? (...) : (...)), RelatedCollection extends (...)[] ? (...) extends (...) ? (...) : (...) : ApplyNestedQueryFields<(...), (...), (...)>> : never : never }>>[], Schema>

List all files that exist in Directus.

Type parameters ​

• Schema

• TQuery extends Query<Schema, DirectusFile<Schema>>

Parameters ​

• query?: TQuery

The query parameters

Returns ​

RestCommand<IfAny<Schema, Record<string, any>, Merge<MappedFunctionFields<Schema, UnpackList<IfAny<Schema, Object, "directus_files" extends keyof Schema ? UnpackList<...> extends Item ? ... & ... : never : Object>>> extends FF ? MapFlatFields<UnpackList<IfAny<Schema, Object, "directus_files" extends keyof Schema ? UnpackList<...> extends Item ? ... & ... : never : Object>>, FieldsWildcard<UnpackList<IfAny<Schema, Object, "directus_files" extends keyof ... ? ... extends ... ? ... : ... : Object>>, Exclude<UnpackList<Mutable<...[...]>>, PickRelationalFields<UnpackList<...>> extends never ? never : AllKeys<... extends ... ? ... : ...>>>, FF extends Record<string, string> ? FF<FF> : Record<string, string>> : never, PickRelationalFields<UnpackList<Mutable<TQuery["fields"]>>> extends never ? never : { [Field in string | number | symbol]: Field extends keyof UnpackList<IfAny<Schema, Object, (...) extends (...) ? (...) : (...)>> ? Extract<UnpackList<(...)>[Field<(...)>], ItemType<Schema>> extends RelatedCollection ? IsNullable<UnpackList<(...)>[Field<(...)>], null | ((...) extends (...) ? (...) : (...)), RelatedCollection extends (...)[] ? (...) extends (...) ? (...) : (...) : ApplyNestedQueryFields<(...), (...), (...)>> : never : never }>>[], Schema>

An array of up to limit file objects. If no items are available, data will be an empty array.

Source ​

rest/commands/read/files.ts:18