modrinthjs/dist/src/models/BaseProject.d.ts

A type safe Modrinth implementation.

export type BaseProject = {
    /**
     * The slug of a project, used for vanity URLs. Regex: ```^[\w!@$()`.+,"\-']{3,64}$```
     */
    slug?: string;
    /**
     * The title or name of the project
     */
    title?: string;
    /**
     * A short description of the project
     */
    description?: string;
    /**
     * A list of the categories that the project has
     */
    categories?: Array<string>;
    /**
     * The client side support of the project
     */
    client_side?: BaseProject.client_side;
    /**
     * The server side support of the project
     */
    server_side?: BaseProject.server_side;
};
export declare namespace BaseProject {
    /**
     * The client side support of the project
     */
    enum client_side {
        REQUIRED = "required",
        OPTIONAL = "optional",
        UNSUPPORTED = "unsupported"
    }
    /**
     * The server side support of the project
     */
    enum server_side {
        REQUIRED = "required",
        OPTIONAL = "optional",
        UNSUPPORTED = "unsupported"
    }
}