@adonisjs/ace/build/src/Generator/StringTransformer.d.ts

Commandline apps framework used by AdonisJs

/**
 * Exposes the API to transform a string
 */
export declare class StringTransformer {
    private input;
    constructor(input: string);
    /**
     * Cleans suffix from the input.
     */
    cleanSuffix(suffix?: string): this;
    /**
     * Cleans prefix from the input.
     */
    cleanPrefix(prefix?: string): this;
    /**
     * Add suffix to the file name
     */
    addSuffix(suffix?: string): this;
    /**
     * Add prefix to the file name
     */
    addPrefix(prefix?: string): this;
    /**
     * Changes the name form by converting it to singular
     * or plural case
     */
    changeForm(form?: 'singular' | 'plural', ignoreList?: string[]): this;
    /**
     * Changes the input case
     */
    changeCase(pattern?: 'pascalcase' | 'camelcase' | 'snakecase' | 'dashcase'): this;
    /**
     * Drops the extension from the input
     */
    dropExtension(): this;
    /**
     * Returns the transformed value
     */
    toValue(): string;
}