Class Category

constructor

• new Category(client, data): Category

• Parameters

  • client: Client

    The main client.

  • data: {
        can_directly_have_models: boolean;
        can_have_subcategories: boolean;
        can_only_mods_apply: boolean;
        category_token: string;
        created_at: Date;
        deleted_at: null | Date;
        is_mod_approved: null | boolean;
        is_synthetic: boolean;
        maybe_super_category_token: null | string;
        model_type: string;
        name: string;
        name_for_dropdown: string;
        should_be_sorted: boolean;
        updated_at: Date;
    }

    The raw category data from the FakeYou API.

    • can_directly_have_models: boolean

    • can_have_subcategories: boolean

    • can_only_mods_apply: boolean

    • category_token: string

    • created_at: Date

    • deleted_at: null | Date

    • is_mod_approved: null | boolean

    • is_synthetic: boolean

    • maybe_super_category_token: null | string

    • model_type: string

    • name: string

    • name_for_dropdown: string

    • should_be_sorted: boolean

    • updated_at: Date

  Returns Category

Readonly canDirectlyHaveModels

Readonly canHaveSubcategories

Readonly canOnlyModsApply

Readonly client

Readonly createdAt

Readonly deletedAt

Readonly isModApproved

Readonly isSynthetic

Readonly modelType

Readonly name

Readonly nameForDropdown

Readonly parentToken

Readonly shouldBeSorted

Readonly token

Readonly updatedAt

fetchModels

• fetchModels(): Promise<TtsModel[]>

• Fetch models that belong to this category.

  Returns Promise<TtsModel[]>

  A list of tts models that belong to this category. The array is empty if no models belong to this category.

getChildren

• getChildren(): Promise<Category[]>

• Fetch the child categories of this category.

  Returns Promise<Category[]>

  The child categories of this category. Empty array if this category has no children.

getParent

• getParent(): Promise<undefined | Category>

• Fetch the parent category of this category.

  Returns Promise<undefined | Category>

  The parent category of this category. Undefined if this category has no parent.