PowerHorse Engine
    Preparing search index...
    interface IFormatMethods {
        End: (this: IFormatMethods) => unknown;
        fromStrToObj: (this: IFormatMethods) => unknown;
        fromUnixStamp: (this: IFormatMethods, is12Hour?: boolean) => IFormatMethods;
        rtBold: (this: IFormatMethods) => IFormatMethods;
        rtColor: (this: IFormatMethods, Color: string | Color3) => IFormatMethods;
        rtComment: (this: IFormatMethods) => IFormatMethods;
        rtFontFace: (this: IFormatMethods, Font: string | Font) => IFormatMethods;
        rtFontFamily: (this: IFormatMethods, FontFamily: string) => IFormatMethods;
        rtFontWeight: (
            this: IFormatMethods,
            FontFamily: string | number,
        ) => IFormatMethods;
        rtItalic: (this: IFormatMethods) => IFormatMethods;
        rtLinebreak: (this: IFormatMethods) => IFormatMethods;
        rtSize: (this: IFormatMethods, Size: string | number) => IFormatMethods;
        rtSmallcaps: (this: IFormatMethods) => IFormatMethods;
        rtStrikethrough: (this: IFormatMethods) => IFormatMethods;
        rtStroke: (
            this: IFormatMethods,
            stroke: Partial<
                {
                    color: Color3
                    | string;
                    joins: string;
                    thickness: string | number;
                    transparency: string | number;
                },
            >,
        ) => IFormatMethods;
        rtTransparency: (
            this: IFormatMethods,
            Transparency: string | number,
        ) => IFormatMethods;
        rtUnderline: (this: IFormatMethods) => IFormatMethods;
        rtUppercase: (this: IFormatMethods) => IFormatMethods;
        toDateFormat: (
            this: IFormatMethods,
            useString?: boolean,
            shortenStrings?: number | boolean,
            indicateDayAsNumber?: boolean,
        ) => string;
        toNumberAbbreviation: (
            this: IFormatMethods,
            decimals?: number,
            includeUnder1k?: boolean,
            abs?: string[],
        ) => IFormatMethods;
        toNumberCommas: (this: IFormatMethods) => IFormatMethods;
        toTimeFormat: (this: IFormatMethods) => unknown;
    }
    Index

    Properties

    End: (this: IFormatMethods) => unknown

    Ends the chain and returns the actual value instead of the metatable.

    fromStrToObj: (this: IFormatMethods) => unknown

    Converts strings into objects

    e.g

    	format("Vector3.new(0,1,0)").fromStrToObj() => Vector3
    format("Instance.new('Part')").fromStrToObj() => Part Instance
    fromUnixStamp: (this: IFormatMethods, is12Hour?: boolean) => IFormatMethods
    rtBold: (this: IFormatMethods) => IFormatMethods
    rtColor: (this: IFormatMethods, Color: string | Color3) => IFormatMethods
    rtComment: (this: IFormatMethods) => IFormatMethods
    rtFontFace: (this: IFormatMethods, Font: string | Font) => IFormatMethods
    rtFontFamily: (this: IFormatMethods, FontFamily: string) => IFormatMethods
    rtFontWeight: (
        this: IFormatMethods,
        FontFamily: string | number,
    ) => IFormatMethods
    rtItalic: (this: IFormatMethods) => IFormatMethods
    rtLinebreak: (this: IFormatMethods) => IFormatMethods
    rtSize: (this: IFormatMethods, Size: string | number) => IFormatMethods
    rtSmallcaps: (this: IFormatMethods) => IFormatMethods
    rtStrikethrough: (this: IFormatMethods) => IFormatMethods
    rtStroke: (
        this: IFormatMethods,
        stroke: Partial<
            {
                color: Color3
                | string;
                joins: string;
                thickness: string | number;
                transparency: string | number;
            },
        >,
    ) => IFormatMethods
    rtTransparency: (
        this: IFormatMethods,
        Transparency: string | number,
    ) => IFormatMethods
    rtUnderline: (this: IFormatMethods) => IFormatMethods
    rtUppercase: (this: IFormatMethods) => IFormatMethods
    toDateFormat: (
        this: IFormatMethods,
        useString?: boolean,
        shortenStrings?: number | boolean,
        indicateDayAsNumber?: boolean,
    ) => string

    Requires to be converted fromUnixStamp first

    Warning: Will End() the chain

    toNumberAbbreviation: (
        this: IFormatMethods,
        decimals?: number,
        includeUnder1k?: boolean,
        abs?: string[],
    ) => IFormatMethods

    Converts 1000 => 1k, 1000000000 => 1M etc.

    toNumberCommas: (this: IFormatMethods) => IFormatMethods

    Converts 1000 => 1,000, 1000000000 => 1,000,000,000 etc.

    toTimeFormat: (this: IFormatMethods) => unknown

    Requires to be converted fromUnixStamp first

    Ends the chain