Directus / @directus/sdk / rest / readFlows

Function: readFlows() ​

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

List all flows that exist in Directus.

Type parameters ​

• Schema extends object

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

Parameters ​

• query?: TQuery

The query parameters

Returns ​

RestCommand<IfAny<Schema, Record<string, any>, Merge<MappedFunctionFields<Schema, UnpackList<MergeCoreCollection<Schema, "directus_flows", Object>>> extends FF ? MapFlatFields<UnpackList<MergeCoreCollection<Schema, "directus_flows", Object>>, FieldsWildcard<UnpackList<MergeCoreCollection<Schema, "directus_flows", Object>>, Exclude<UnpackList<Mutable<...[...]>>, PickRelationalFields<UnpackList<...>> extends never ? never : AllKeys<... extends ... ? ... : ...>>>, FF extends Record<string, string> ? FF : Record<string, string>> : never, PickRelationalFields<UnpackList<Mutable<TQuery["fields"]>>> extends never ? never : { [Field in string | number | symbol]: Field extends keyof UnpackList<MergeCoreCollection<Schema, "directus_flows", Object>> ? 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 flow objects. If no items are available, data will be an empty array.

Source ​

rest/commands/read/flows.ts:18