@directus/sdk/dist/rest/commands/create/collections.d.ts

Directus JavaScript SDK

import { DirectusCollection } from "../../../schema/collection.js";
import { NestedPartial } from "../../../types/utils.js";
import { ApplyQueryFields } from "../../../types/output.js";
import { FieldQuery, Query } from "../../../types/query.js";
import { RestCommand } from "../../types.js";

//#region src/rest/commands/create/collections.d.ts
type CreateCollectionOutput<Schema, TQuery extends Query<Schema, Item>, Item extends object = DirectusCollection<Schema>> = ApplyQueryFields<Schema, Item, TQuery["fields"]>;
/**
* Create a new Collection. This will create a new table in the database as well.
*
* @param item This endpoint doesn't currently support any query parameters.
* @param query Optional return data query
*
* @returns The collection object for the collection created in this request.
*/
declare const createCollection: <Schema, const TQuery extends FieldQuery<Schema, DirectusCollection<Schema>>>(item: NestedPartial<DirectusCollection<Schema>>, query?: TQuery) => RestCommand<CreateCollectionOutput<Schema, TQuery>, Schema>;
//#endregion
export { CreateCollectionOutput, createCollection };
//# sourceMappingURL=collections.d.ts.map