Class PresetRegistry

Registry of named scan presets.

Presets are plain serializable objects and may inherit from another preset through extends.

Hierarchy

Registry<PresetDefinition>
- PresetRegistry

Index

Constructors

constructor

Methods

define export fromUrl get has import load names remove resolve set update

Constructors

constructor

new PresetRegistry(initial?: PresetMap): PresetRegistry
Parameters
- initial: PresetMap = {}
  Definitions loaded into the registry.
Returns PresetRegistry
Overrides Registry<PresetDefinition>.constructor
- Defined in presets.ts:418

Methods

define

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

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

export

export(name?: string): PresetDefinition | PresetMap
Returns one preset by name, or a map of all presets.
Parameters
- Optionalname: string
  Optional preset name.
Returns PresetDefinition | PresetMap
The requested preset or a map of every preset.
- Defined in presets.ts:526

fromUrl

fromUrl(url: string, name?: string): Promise<string[]>
Loads presets from a JSON document over HTTP.

The document is either a single preset definition — registered under the supplied name — or a preset map of { presetName: definition } entries imported wholesale.
Parameters
- url: string
  URL of the JSON document.
- Optionalname: string
  Preset name for a single definition. Required when the document is not a preset map.
Returns Promise<string[]>
The registered preset names.
Throws
When the fetch fails or the document shape cannot be identified.
Example
```
// A map of presets: { "newsprint": { ... }, ... }
await presets.fromUrl("./presets/office.json");

// A single definition: { "extends": "clean", ... }
await presets.fromUrl("./presets/newsprint.json", "newsprint");
```
- Defined in presets.ts:458

get

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

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

import

import(definitions: PresetMap): void
Registers every definition in a preset map.
Parameters
- definitions: PresetMap
  Presets to add or replace by name.
Returns void
- Defined in presets.ts:514

`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

resolve

resolve(name?: string): ScanSettings
Resolves a preset and its inheritance chain into complete settings.

The resolved definition is merged over defaultSettings.
Parameters
- name: string = "clean"
  Preset name to resolve. Defaults to "clean".
Returns ScanSettings
Complete scan settings.

Throws
When the preset is unknown or its extends chain is circular.
- Defined in presets.ts:550

set

set(name: string, definition: PresetDefinition): void
Stores or replaces a definition.
Parameters
- name: string
  Unique definition name.
- definition: PresetDefinition
  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: PresetDefinition): void
Merges changes into an existing preset.
Parameters
- name: string
  Name of the preset to update.
- changes: PresetDefinition
  Partial preset merged over the current definition.
Returns void

Throws
When the preset does not exist.
Overrides Registry.update
- Defined in presets.ts:431

Class PresetRegistry

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns PresetRegistry

Methods

define

Parameters

Returns void

Throws

export

Parameters

Returns PresetDefinition | PresetMap

fromUrl

Parameters

Returns Promise<string[]>

Throws

Example

get

Parameters

Returns PresetDefinition

Throws

has

Parameters

Returns boolean

import

Parameters

Returns void

Protectedload

Parameters

Returns void

names

Returns string[]

remove

Parameters

Returns boolean

resolve

Parameters

Returns ScanSettings

Throws

set

Parameters

Returns void

Throws

update

Parameters

Returns void

Throws

Settings

On This Page

`Protected`load