outers/lib/UniqueGen/Base.d.ts

outers - a all in one package for your day to day use

export declare class UniqueGen {
    #private;
    constructor(length: number);
    /**
     * The function "RandomNumber" generates a random number with the option to include zero and the
     * ability to provide a custom set of numbers.
     * @param {boolean} [withzero=true] - The "withzero" parameter is a boolean value that determines
     * whether or not the generated random number can include zero. If set to true, zero can be included
     * in the range of possible random numbers. If set to false, zero will not be included in the range.
     * @param {number[]} [CustomNumbers] - The `CustomNumbers` parameter is an optional array of numbers
     * that you can pass to the `RandomNumber` function. If you provide this parameter, the function
     * will generate a random number from the `CustomNumbers` array. If you don't provide this
     * parameter, the function will generate a random number
     * @returns a random number.
     */
    RandomNumber(withzero?: boolean, CustomNumbers?: number[]): number;
    /**
     * The RandomWord function generates a random word with an optional parameter to make it all capital
     * letters and an optional array of custom words to choose from.
     * @param {boolean} [isCAPITAL=false] - The `isCAPITAL` parameter is a boolean value that determines
     * whether the generated random word should be in all capital letters or not. If `isCAPITAL` is set to
     * `true`, the generated word will be in all capital letters. If `isCAPITAL` is set to `false
     * @param {string[]} [CustomWords] - The `CustomWords` parameter is an optional array of strings that
     * allows you to provide your own set of words from which the random word will be selected. If you
     * don't provide any custom words, the function will use a default set of words.
     * @returns a random word.
     */
    RandomWord(isCAPITAL?: boolean, CustomWords?: string[]): string;
    /**
     * The function "RandomMixed" generates a random mixed string with optional capitalization and custom
     * character options.
     * @param {boolean} [isCAPITAL=false] - The `isCAPITAL` parameter is a boolean value that determines
     * whether the generated random mixed string should include capital letters or not. If `isCAPITAL` is
     * set to `true`, capital letters will be included in the generated string. If it is set to `false` or
     * not provided,
     * @param {string[]} [CustomMixeds] - CustomMixeds is an optional parameter of type string array. It
     * allows you to provide a custom set of characters that will be used for generating the random mixed
     * string. If you don't provide any custom set, the function will use a default set of characters.
     * @returns The function `RandomMixed` returns the result of calling the `randomMixed` function with
     * the `_length` property, `isCAPITAL` argument, and `CustomMixeds` argument.
     */
    RandomMixed(isCAPITAL?: boolean, CustomMixeds?: string[]): string;
    /**
     * The function "RandomSymbol" generates a random symbol based on a specified length and optional
     * custom symbols.
     * @param {string[]} [CustomSymbols] - CustomSymbols is an optional parameter of type string array. It
     * allows you to pass an array of custom symbols that you want to include in the random symbol
     * generation. If you don't provide any custom symbols, the function will generate a random symbol from
     * a default set of symbols.
     * @returns the result of calling the `randomSymbol` function with the `_length` parameter and the
     * `CustomSymbols` array as arguments.
     */
    RandomSymbol(CustomSymbols?: string[]): string;
    /**
     * Generates a random boolean value.
     * @returns {boolean} A random boolean value.
     */
    RandomBoolean(): boolean;
    /**
     * Sets the length property of the instance.
     * This method updates the instance's length with the provided numeric value, ensuring that it is a positive number.
     *
     * @param {number} length - The new length value to be set. Must be a positive number.
     * @throws {Error} Throws an error if `length` is not provided, is not a number, or is less than or equal to zero.
     */
    setLength(length: number): void;
}