Class BindingRegistry

Registry of named gutter styles.

Hierarchy

Registry<GutterOptions>
- BindingRegistry

Index

Constructors

Methods

define get has load names remove set update

Constructors

constructor

new BindingRegistry(initial?: Record<string, GutterOptions>): BindingRegistry
Parameters
- initial: Record<string, GutterOptions> = {}
  Definitions loaded into the registry.
Returns BindingRegistry
Overrides Registry<GutterOptions>.constructor
- Defined in bindings.ts:57

Methods

define

define(name: string, definition: GutterOptions): void
Registers a new definition.
Parameters
- name: string
  Unique definition name.
- definition: GutterOptions
  Definition to store.
Returns void

Throws
When the name already exists.
Inherited from Registry.define
- Defined in registry.ts:41

get

get(name: string): GutterOptions
Returns a copy of a definition.
Parameters
- name: string
  Name of the definition to read.
Returns GutterOptions

Throws
When the definition does not exist.
Inherited from Registry.get
- Defined in registry.ts:81

has

has(name: string): boolean
Checks whether a definition is registered.
Parameters
- name: string
Returns boolean
Inherited from Registry.has
- Defined in registry.ts:94

`Protected`load

load(initial: Record<string, T>): void
Parameters
- initial: Record<string, T>
Returns void
Inherited from Registry.load
- Defined in registry.ts:28

names

names(): string[]
Returns all registered definition names.

Returns string[]
Inherited from Registry.names
- Defined in registry.ts:101

remove

remove(name: string): boolean
Removes a definition.
Parameters
- name: string
Returns boolean
true when the definition existed.
Inherited from Registry.remove
- Defined in registry.ts:110

set

set(name: string, definition: GutterOptions): void
Stores or replaces a definition.
Parameters
- name: string
  Unique definition name.
- definition: GutterOptions
  Definition to store.
Returns void

Throws
When empty names are not allowed and name is blank.
Inherited from Registry.set
- Defined in registry.ts:56

update

update(name: string, changes: DeepPartial<T>): void
Merges changes into an existing definition.
Parameters
- name: string
  Name of the definition to update.
- changes: DeepPartial<T>
  Partial definition merged over the current value.
Returns void

Throws
When the definition does not exist.
Inherited from Registry.update
- Defined in registry.ts:71