AeontelAeontel Docs

Skills hooks

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

Hooks

useCreateSkill mutation

Create a new skill.

TypeScript
useCreateSkill(options?: MutationOpts<Skill, CreateSkillParams>)

Types: Skill · CreateSkillParams

useDeleteSkill mutation

Soft-delete a skill.

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

Types: SuccessResponse

useListSkills query

List skills with pagination and optional filtering.

TypeScript
useListSkills(params?: Omit<ListSkillsParams, | > & { filter?: SkillFilter; orderBy?: SkillOrderBy[]; } & SkillShorthands, options?: QueryOpts<Page<Skill>>)

Types: ListSkillsParams · SkillFilter · SkillOrderBy · SkillShorthands · Page · Skill

usePurgeSkill composite

Permanently delete a soft-deleted skill.

TypeScript
usePurgeSkill(options?: MutationOpts<SuccessResponse, PurgeSkillParams>)

Types: SuccessResponse · PurgeSkillParams

useRestoreSkill composite

Restore a soft-deleted skill.

TypeScript
useRestoreSkill(options?: MutationOpts<Skill, string>)

Types: Skill

useRetrieveSkill query

Get a single skill by ID.

TypeScript
useRetrieveSkill(id: string, options?: QueryOpts<Skill>)

Types: Skill

useUpdateSkill mutation

Update a skill.

TypeScript
useUpdateSkill(options?: MutationOpts<Skill, UpdateSkillParams>)

Types: Skill · UpdateSkillParams