Class Tokens_Colour_ShadeMap<T_ColourName, T_ExtraLevels>`Internal`

Generates a complete token object for the design system.

Since

0.1.0-alpha

Type Parameters

T_ColourName extends string
T_ExtraLevels extends Optional

Hierarchy (View Summary)

AbstractTokens<Tokens_Colour_ShadeMap.Data<T_ColourName, T_ExtraLevels>>
- Tokens_Colour_ShadeMap

Index

Constructors

constructor

new Tokens_Colour_ShadeMap<
    T_ColourName extends string,
    T_ExtraLevels extends "350" | "450" | "550" | "650",
>(
    allNames: readonly T_ColourName[],
    extraLevels: readonly T_ExtraLevels[],
    name: T_ColourName,
    input: Tokens_Colour_ShadeMap.InputParam<T_ColourName, T_ExtraLevels>,
): Tokens_Colour_ShadeMap<T_ColourName, T_ExtraLevels>
Internal
Type Parameters
- T_ColourName extends string
- T_ExtraLevels extends "350" | "450" | "550" | "650"
Parameters
- allNames: readonly T_ColourName[]
- extraLevels: readonly T_ExtraLevels[]
- name: T_ColourName
- input: Tokens_Colour_ShadeMap.InputParam<T_ColourName, T_ExtraLevels>
Returns Tokens_Colour_ShadeMap<T_ColourName, T_ExtraLevels>
Overrides AbstractTokens.constructor
- Defined in 02-tokens/Colour/Colour_ShadeMap.ts:31

Properties

`Static` `Readonly` `Internal`tokenLevels

tokenLevels: readonly [
    "100",
    "200",
    "300",
    "400",
    "500",
    "600",
    "700",
    "800",
    "900",
] = ...

`Static` `Readonly` `Internal`tokenLevels_extraOptions

tokenLevels_extraOptions: readonly [
    "150",
    "250",
    "350",
    "450",
    "550",
    "650",
    "750",
    "850",
] = ...

`Readonly` `Internal`data

data: Tokens_Colour_ShadeMap.Data<T_ColourName, T_ExtraLevels>

The value of this token.

Since

0.1.0-alpha

`Readonly` `Internal`tokenLevels

tokenLevels: readonly [
    "100",
    "200",
    "300",
    "400",
    "500",
    "600",
    "700",
    "800",
    "900",
] = AbstractTokens.tokenLevels

`Protected` `Readonly` `Internal`allNames

allNames: readonly T_ColourName[]

`Protected` `Readonly` `Internal`extraLevels

extraLevels: readonly T_ExtraLevels[]

`Protected` `Readonly` `Internal`name

name: T_ColourName

Methods

`Static`customErrorMap

customErrorMap(
...params: [issue: ZodIssueOptionalMessage, _ctx: ErrorMapCtx],
): { message: string }
Internal
A custom error handler to use with Zod schemas.
Parameters
- ...params: [issue: ZodIssueOptionalMessage, _ctx: ErrorMapCtx]
Returns { message: string }
Since
0.1.0-alpha
Inherited from AbstractTokens.customErrorMap
- Defined in 02-tokens/abstract/AbstractTokens.ts:81

addContrastTests

addContrastTests(
colourGroupName: T_ColourName,
testMap: Tokens_Colour_ShadeMap<T_ColourName, T_ExtraLevels>,
): Promise<void[]>
Internal
Adds the given shade map to this map's shades' contrast results.
Parameters
- colourGroupName: T_ColourName
- testMap: Tokens_Colour_ShadeMap<T_ColourName, T_ExtraLevels>
Returns Promise<void[]>
Since
0.1.0-alpha
- Defined in 02-tokens/Colour/Colour_ShadeMap.ts:52

toJSON

toJSON(): Tokens_Colour_ShadeMap.JsonReturn<T_ColourName, T_ExtraLevels>
Internal
Converts this token or group to a json-compatible object. NOT W3C tokens -- this is meant to be more human-readable.

Uses AbstractTokens.schemaJSON.

Returns Tokens_Colour_ShadeMap.JsonReturn<T_ColourName, T_ExtraLevels>
Since
0.1.0-alpha
Overrides AbstractTokens.toJSON
- Defined in 02-tokens/Colour/Colour_ShadeMap.ts:77

toScss

toScss(): string
Internal
Uses AbstractTokens.toScssVars to convert this token to a scss string.

Returns string
Since
0.1.0-alpha
Inherited from AbstractTokens.toScss
- Defined in 02-tokens/abstract/AbstractTokens.ts:144

toScssVars

toScssVars(): {
    [K in | "100"
    | "150"
    | "200"
    | "250"
    | "300"
    | "400"
    | "500"
    | "600"
    | "700"
    | "750"
    | "800"
    | "850"
    | "900"
    | "350"
    | "450"
    | "550"
    | "650"]: ScssReturn
}
Internal
Converts this token or group to the values used when converting to scss.

Returns {
    [K in
        | "100"
        | "150"
        | "200"
        | "250"
        | "300"
        | "400"
        | "500"
        | "600"
        | "700"
        | "750"
        | "800"
        | "850"
        | "900"
        | "350"
        | "450"
        | "550"
        | "650"]: ScssReturn
}
Since
0.1.0-alpha
Overrides AbstractTokens.toScssVars
- Defined in 02-tokens/Colour/Colour_ShadeMap.ts:85

valueOf

valueOf(): T_DataType
Internal
The working value of this object.

Returns T_DataType
Since
0.1.0-alpha
Inherited from AbstractTokens.valueOf
- Defined in 02-tokens/abstract/AbstractTokens.ts:154

`Protected`parseSchema

parseSchema<T_Schema extends ZodTypeAny, T_ValueToTest extends unknown>(
    schema: T_Schema,
    value: T_ValueToTest,
    context: Context,
    errorMessage?: string,
    params?: Parameters<T_Schema["safeParse"]>[1],
): TypeOf<T_Schema>
Internal
A utility for parsing Zod schemas with appropriate error handling.
Type Parameters
- T_Schema extends ZodTypeAny
- T_ValueToTest extends unknown
Parameters
- schema: T_Schema
  Schema to use when parsing the value.
- value: T_ValueToTest
  The value to check against the schema.
- context: Context
  A context object used for AbstractTokens.Tokens_Error if the parsing fails.
- errorMessage: string = 'Error parsing Zod schema'
  Optional. Message to use if the parsing fails.
- params: Parameters<T_Schema["safeParse"]>[1] = {}
  Optional. Parameters passed to the Zod schema's safeParse method.
Returns TypeOf<T_Schema>
Throws
If the schema parsing fails.

Since
0.1.0-alpha
Inherited from AbstractTokens.parseSchema
- Defined in 02-tokens/abstract/AbstractTokens.ts:176

Class Tokens_Colour_ShadeMap<T_ColourName, T_ExtraLevels>Internal

Since

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Tokens_Colour_ShadeMap<T_ColourName, T_ExtraLevels>

Properties

Static Readonly InternaltokenLevels

Static Readonly InternaltokenLevels_extraOptions

Readonly Internaldata

Since

Readonly InternaltokenLevels

Protected Readonly InternalallNames

Protected Readonly InternalextraLevels

Protected Readonly Internalname

Methods

StaticcustomErrorMap

Parameters

Returns { message: string }

Since

addContrastTests

Parameters

Returns Promise<void[]>

Since

toJSON

Returns Tokens_Colour_ShadeMap.JsonReturn<T_ColourName, T_ExtraLevels>

Since

toScss

Returns string

Since

toScssVars

Returns { [K in | "100" | "150" | "200" | "250" | "300" | "400" | "500" | "600" | "700" | "750" | "800" | "850" | "900" | "350" | "450" | "550" | "650"]: ScssReturn}

Since

valueOf

Returns T_DataType

Since

ProtectedparseSchema

Type Parameters

Parameters

Returns TypeOf<T_Schema>

Throws

Since

Settings

On This Page

Class Tokens_Colour_ShadeMap<T_ColourName, T_ExtraLevels>`Internal`

`Static` `Readonly` `Internal`tokenLevels

`Static` `Readonly` `Internal`tokenLevels_extraOptions

`Readonly` `Internal`data

`Readonly` `Internal`tokenLevels

`Protected` `Readonly` `Internal`allNames

`Protected` `Readonly` `Internal`extraLevels

`Protected` `Readonly` `Internal`name

`Static`customErrorMap

Returns {
[K in
| "100"
| "150"
| "200"
| "250"
| "300"
| "400"
| "500"
| "600"
| "700"
| "750"
| "800"
| "850"
| "900"
| "350"
| "450"
| "550"
| "650"]: ScssReturn
}

`Protected`parseSchema