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
29 lines
1.5 KiB
Plaintext
29 lines
1.5 KiB
Plaintext
import { DirectusRelation } from "../../../schema/relation.cjs";
|
|
import { ApplyQueryFields } from "../../../types/output.cjs";
|
|
import { RestCommand } from "../../types.cjs";
|
|
|
|
//#region src/rest/commands/read/relations.d.ts
|
|
type ReadRelationOutput<Schema> = ApplyQueryFields<Schema, DirectusRelation<Schema>, '*'>;
|
|
/**
|
|
* List all Relations that exist in Directus.
|
|
* @returns An array of Relation objects. If no items are available, data will be an empty array.
|
|
*/
|
|
declare const readRelations: <Schema>() => RestCommand<ReadRelationOutput<Schema>[], Schema>;
|
|
/**
|
|
* List all Relations of a collection.
|
|
* @param collection The collection
|
|
* @returns Returns an array of Relation objects if a valid collection name was provided.
|
|
*/
|
|
declare const readRelationByCollection: <Schema>(collection: DirectusRelation<Schema>["collection"]) => RestCommand<ReadRelationOutput<Schema>[], Schema>;
|
|
/**
|
|
* List an existing Relation by collection and field name.
|
|
* @param collection The collection
|
|
* @param field The field
|
|
* @returns Returns a Relation object if a valid collection and field name was provided.
|
|
* @throws Will throw if collection is empty
|
|
* @throws Will throw if field is empty
|
|
*/
|
|
declare const readRelation: <Schema>(collection: DirectusRelation<Schema>["collection"], field: DirectusRelation<Schema>["field"]) => RestCommand<ReadRelationOutput<Schema>, Schema>;
|
|
//#endregion
|
|
export { ReadRelationOutput, readRelation, readRelationByCollection, readRelations };
|
|
//# sourceMappingURL=relations.d.cts.map |