Marc Mintel
5397309103
Some checks failed
Build & Deploy / 🔍 Prepare (push) Successful in 20s
Build & Deploy / 🧪 QA (push) Failing after 34s
Build & Deploy / 🏗️ Build (push) Has started running
Build & Deploy / 🚀 Deploy (push) Has been cancelled
Build & Deploy / 🧪 Smoke Test (push) Has been cancelled
Build & Deploy / ⚡ Lighthouse (push) Has been cancelled
Build & Deploy / 🔔 Notify (push) Has been cancelled
31 lines
1.3 KiB
Plaintext
31 lines
1.3 KiB
Plaintext
import { DirectusField } from "../../../schema/field.cjs";
|
|
import { ApplyQueryFields } from "../../../types/output.cjs";
|
|
import { RestCommand } from "../../types.cjs";
|
|
|
|
//#region src/rest/commands/read/fields.d.ts
|
|
type ReadFieldOutput<Schema, Item extends object = DirectusField<Schema>> = ApplyQueryFields<Schema, Item, '*'>;
|
|
/**
|
|
* List the available fields.
|
|
* @param query The query parameters
|
|
* @returns An array of field objects.
|
|
*/
|
|
declare const readFields: <Schema>() => RestCommand<ReadFieldOutput<Schema>[], Schema>;
|
|
/**
|
|
* List the available fields in a given collection.
|
|
* @param collection The primary key of the field
|
|
* @returns
|
|
* @throws Will throw if collection is empty
|
|
*/
|
|
declare const readFieldsByCollection: <Schema>(collection: DirectusField<Schema>["collection"]) => RestCommand<ReadFieldOutput<Schema>[], Schema>;
|
|
/**
|
|
*
|
|
* @param key The primary key of the dashboard
|
|
* @param query The query parameters
|
|
* @returns
|
|
* @throws Will throw if collection is empty
|
|
* @throws Will throw if field is empty
|
|
*/
|
|
declare const readField: <Schema>(collection: DirectusField<Schema>["collection"], field: DirectusField<Schema>["field"]) => RestCommand<ReadFieldOutput<Schema>, Schema>;
|
|
//#endregion
|
|
export { ReadFieldOutput, readField, readFields, readFieldsByCollection };
|
|
//# sourceMappingURL=fields.d.cts.map |