Directus / @directus/sdk / rest / createFlow
Function: createFlow() ​
createFlow<
Schema,TQuery>(item,query?):RestCommand<IfAny<Schema,Record<string,any>, { [K in string | number | symbol]: Merge<MappedFunctionFields<Schema, UnpackList<IfAny<Schema, Object, "directus_flows" extends keyof (...) ? (...) extends (...) ? (...) : (...) : Object>>> extends FF ? MapFlatFields<UnpackList<IfAny<Schema, Object, "directus_flows" extends keyof (...) ? (...) extends (...) ? (...) : (...) : Object>>, FieldsWildcard<UnpackList<IfAny<Schema, Object, (...) extends (...) ? (...) : (...)>>, Exclude<UnpackList<Mutable<(...)>>, PickRelationalFields<(...)> extends never ? never : AllKeys<(...)>>>, 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<(...), (...), (...)>> ? Extract<(...)[(...)], ItemType<(...)>> extends RelatedCollection ? IsNullable<(...)[(...)], (...) | (...), (...) extends (...) ? (...) : (...)> : never : never }>[K] }>,Schema>
Create a new flow.
Type Parameters ​
• Schema
• TQuery extends Query<Schema, DirectusFlow<Schema>>
Parameters ​
• item: Partial<DirectusFlow<Schema>>
The flow to create
• query?: TQuery
Optional return data query
Returns ​
RestCommand<IfAny<Schema, Record<string, any>, { [K in string | number | symbol]: Merge<MappedFunctionFields<Schema, UnpackList<IfAny<Schema, Object, "directus_flows" extends keyof (...) ? (...) extends (...) ? (...) : (...) : Object>>> extends FF ? MapFlatFields<UnpackList<IfAny<Schema, Object, "directus_flows" extends keyof (...) ? (...) extends (...) ? (...) : (...) : Object>>, FieldsWildcard<UnpackList<IfAny<Schema, Object, (...) extends (...) ? (...) : (...)>>, Exclude<UnpackList<Mutable<(...)>>, PickRelationalFields<(...)> extends never ? never : AllKeys<(...)>>>, 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<(...), (...), (...)>> ? Extract<(...)[(...)], ItemType<(...)>> extends RelatedCollection ? IsNullable<(...)[(...)], (...) | (...), (...) extends (...) ? (...) : (...)> : never : never }>[K] }>, Schema>
Returns the flow object for the created flow.