Class ThemeBuilder

The main Theme Builder class.

Hierarchy

ThemeBuilder

Implements

IThemeBuilder

Index

Methods

addDesignSystem deleteDesignSystem getDesignSystem listDesignSystemNames create

Methods

addDesignSystem

addDesignSystem(name: string, opts?: {
sample?: boolean;
}): Promise<DesignSystem>
Add a new design system to the theme builder.

Returns
The new design system
Parameters
- name: string
  
  The name of the design system to add.
- Optional opts: {
  sample?: boolean;
  }
  
  Optional arguments. opts.sample=true if this is a sample design system.
  - Optional sample?: boolean
Returns Promise<DesignSystem>
- Defined in src/themeBuilder.ts:62

deleteDesignSystem

deleteDesignSystem(name: string): Promise<void>
Delete the design system named 'name'.
Parameters
- name: string
  
  The name of the design system to delete.
Returns Promise<void>
- Defined in src/themeBuilder.ts:91

getDesignSystem

getDesignSystem(name: string): Promise<DesignSystem>
Get an existing design system by name

Returns
The design system with the specified name, or throws an error otherwise.
Parameters
- name: string
  
  The name of the design system to return.
Returns Promise<DesignSystem>
- Defined in src/themeBuilder.ts:73

listDesignSystemNames

listDesignSystemNames(): Promise<string[]>
Get a list of all design system names.

Returns
The list of all design system names.

Returns Promise<string[]>
- Defined in src/themeBuilder.ts:114

`Static` create

create(opts?: ThemeBuilderOpts): Promise<ThemeBuilder>
Create a theme builder.

Returns
The ThemeBuilder object.
Parameters
- Optional opts: ThemeBuilderOpts
  
  Theme Builder options.
Returns Promise<ThemeBuilder>
- Defined in src/themeBuilder.ts:43

Generated using TypeDoc