AeontelAeontel Docs

Directories hooks

Hand-written shim. Implementation is generated; see ./directories.gen.

Hooks

useCreateDirectory mutation

Create a new directory.

TypeScript
useCreateDirectory(options?: MutationOpts<Directory, CreateDirectoryParams>)

Types: Directory · CreateDirectoryParams

useDeleteDirectory mutation

Soft-delete a directory.

TypeScript
useDeleteDirectory(options?: MutationOpts<SuccessResponse, string>)

Types: SuccessResponse

useListDirectories query

List directories with pagination.

TypeScript
useListDirectories(params?: Omit<ListDirectoriesParams, | > & { filter?: DirectoryFilter; orderBy?: DirectoryOrderBy[]; } & DirectoryShorthands, options?: QueryOpts<Page<Directory>>)

Types: ListDirectoriesParams · DirectoryFilter · DirectoryOrderBy · DirectoryShorthands · Page · Directory

usePurgeDirectory composite

Permanently delete a soft-deleted directory.

TypeScript
usePurgeDirectory(options?: MutationOpts<SuccessResponse, PurgeDirectoryParams>)

Types: SuccessResponse · PurgeDirectoryParams

useRestoreDirectory composite

Restore a soft-deleted directory.

TypeScript
useRestoreDirectory(options?: MutationOpts<Directory, string>)

Types: Directory

useRetrieveDirectory query

Get a single directory by ID.

TypeScript
useRetrieveDirectory(id: string, options?: QueryOpts<Directory>)

Types: Directory

useUpdateDirectory mutation

Update a directory.

TypeScript
useUpdateDirectory(options?: MutationOpts<Directory, UpdateDirectoryParams>)

Types: Directory · UpdateDirectoryParams