persian-ts/dist/persian-ts.d.ts

Variety of Persian tools, all gathered in one place

/**
 * Main class for handling conversion
 * it's using builder pattern to create the desired output
 */
declare class PersianTs {
    private value;
    /**
     * Creates an instance of persian ts.
     *
     * @param value value to be transformed
     */
    constructor(value: string);
    /**
     * converts string containing arabic characters to persian
     *
     * @returns  PersianTs instance
     */
    arabicChar(): PersianTs;
    /**
     * converts string containing arabic numerals to persian
     *
     * @returns  PersianTs instance
     */
    arabicNumber(): PersianTs;
    /**
     * converts string containing persian numerals to english
     *
     * @returns  PersianTs instance
     */
    persianNumber(): PersianTs;
    /**
     * converts string containing english numerals to persian
     *
     * @returns  PersianTs instance
     */
    englishNumber(): PersianTs;
    /**
     * converts string containing persian and arabic numerals to english
     *
     * @returns  PersianTs instance
     */
    toEnglishNumber(): PersianTs;
    /**
     * Used to convert unreadable Persian characters in URL to readable characters.
     *
     * @returns  PersianTs instance
     */
    fixURL(): PersianTs;
    /**
     * Used to convert unreadable Persian characters in URL to readable characters.
     *
     * @returns  PersianTs instance
     */
    decodeURL(): PersianTs;
    /**
     * Used for converting Persian char to English char.
     *
     * @returns  PersianTs instance
     */
    switchKey(): PersianTs;
    /**
     * Zero-width non-joiner correction
     *
     * @returns  PersianTs instance
     */
    halfSpace(): PersianTs;
    /**
     * returns the converted string value.
     *
     * @returns  converted string value
     */
    toString(): string;
}
export default PersianTs;