Variable defaultConst

    default: {
        colorGenerator: ((quantity?) => string | string[]);
        deepCopy: (<T>(object) => T);
        getGitVersion: (() => string);
        groupToAvatar: ((group) => ReactNode);
        projectToAvatar: ((project) => ReactNode);
        rgbToHex: ((color) => string);
        rgbToRgba: ((color?, alpha?) => string);
        stringToColor: ((str?) => string);
        userToAvatar: ((user) => ReactNode);
        usermodelToAvatar: ((usermodel) => ReactNode);
        validateEmail: ((email) => boolean);
        workspaceToAvatar: ((workspace) => ReactNode);
    } = ...

    Type declaration

    • colorGenerator: ((quantity?) => string | string[])
        • (quantity?): string | string[]
        • Contrasting color generator

          Parameters

          • Optional quantity: number

            Number

          Returns string | string[]

          HEX array

    • deepCopy: (<T>(object) => T)
        • <T>(object): T
        • Deep copy

          Type Parameters

          • T extends {}

          Parameters

          • object: T

            Object

          Returns T

          Copy

    • getGitVersion: (() => string)
        • (): string
        • Get git version

          Returns string

          Git version

    • groupToAvatar: ((group) => ReactNode)
        • (group): ReactNode
        • Group to avatar

          Parameters

          • group: {
                id?: string;
                name?: string;
            }

            Group

            • Optional id?: string
            • Optional name?: string

          Returns ReactNode

          Avatar

    • projectToAvatar: ((project) => ReactNode)
        • (project): ReactNode
        • Project to avatar

          Parameters

          • project: {
                id?: string;
                title?: string;
            }

            Project

            • Optional id?: string
            • Optional title?: string

          Returns ReactNode

          Avatar

    • rgbToHex: ((color) => string)
        • (color): string
        • RGB to Hex

          Parameters

          • color: {
                b: number;
                g: number;
                r: number;
            }

            Color {r, g, b}

            • b: number
            • g: number
            • r: number

          Returns string

          Hex

    • rgbToRgba: ((color?, alpha?) => string)
        • (color?, alpha?): string
        • rgb to CSS rgba

          Parameters

          • Optional color: {
                b: number;
                g: number;
                r: number;
            }

            Color {r, g, b}

            • b: number
            • g: number
            • r: number
          • alpha: number = 1

            Alpha

          Returns string

          rgba

    • stringToColor: ((str?) => string)
        • (str?): string
        • String to color

          Parameters

          • Optional str: string

            String

          Returns string

          HSL color

    • userToAvatar: ((user) => ReactNode)
        • (user): ReactNode
        • User to avatar

          Parameters

          • user: {
                avatar?: Buffer;
                email?: string;
                firstname?: string;
                id?: string;
                lastname?: string;
                pending?: boolean;
            }

            User

            • Optional avatar?: Buffer
            • Optional email?: string
            • Optional firstname?: string
            • Optional id?: string
            • Optional lastname?: string
            • Optional pending?: boolean

          Returns ReactNode

          Avatar

    • usermodelToAvatar: ((usermodel) => ReactNode)
        • (usermodel): ReactNode
        • Usermodel to avatar

          Parameters

          • usermodel: {
                id?: string;
                model?: IModel;
            }

            User model

            • Optional id?: string
            • Optional model?: IModel

          Returns ReactNode

          Avatar

    • validateEmail: ((email) => boolean)
        • (email): boolean
        • Validate email

          Parameters

          • email: string

            Email

          Returns boolean

          Valid

    • workspaceToAvatar: ((workspace) => ReactNode)
        • (workspace): ReactNode
        • Workspace to avatar

          Parameters

          • workspace: {
                id?: string;
                name?: string;
            }

            Workspace

            • Optional id?: string
            • Optional name?: string

          Returns ReactNode

          Avatar

    Generated using TypeDoc and TypeDoc Airthium Plugin