Developer Preview — This project is in active development. APIs may change. Provide feedback
Skip to content

@salesforce/b2c-tooling-sdk / scaffold / ScaffoldRegistry

Class: ScaffoldRegistry

Defined in: packages/b2c-tooling-sdk/src/scaffold/registry.ts:132

Scaffold registry for discovering and managing scaffolds

Constructors

Constructor

new ScaffoldRegistry(): ScaffoldRegistry

Returns

ScaffoldRegistry

Methods

addProviders()

addProviders(providers): void

Defined in: packages/b2c-tooling-sdk/src/scaffold/registry.ts:140

Add scaffold providers

Parameters

providers

ScaffoldProvider[]

Returns

void


addTransformers()

addTransformers(transformers): void

Defined in: packages/b2c-tooling-sdk/src/scaffold/registry.ts:148

Add scaffold transformers

Parameters

transformers

ScaffoldTransformer[]

Returns

void


clearCache()

clearCache(): void

Defined in: packages/b2c-tooling-sdk/src/scaffold/registry.ts:156

Clear the scaffold cache

Returns

void


getScaffold()

getScaffold(id, options): Promise<Scaffold | null>

Defined in: packages/b2c-tooling-sdk/src/scaffold/registry.ts:243

Get a specific scaffold by ID

Parameters

id

string

Scaffold ID

options

ScaffoldDiscoveryOptions = {}

Discovery options

Returns

Promise<Scaffold | null>

Scaffold or null if not found


getScaffolds()

getScaffolds(options): Promise<Scaffold[]>

Defined in: packages/b2c-tooling-sdk/src/scaffold/registry.ts:165

Get all scaffolds from all sources

Parameters

options

ScaffoldDiscoveryOptions = {}

Discovery options

Returns

Promise<Scaffold[]>

Array of scaffolds (deduplicated by name, later sources override earlier)


searchScaffolds()

searchScaffolds(query, options): Promise<Scaffold[]>

Defined in: packages/b2c-tooling-sdk/src/scaffold/registry.ts:254

Search scaffolds by query

Parameters

query

string

Search query

options

ScaffoldDiscoveryOptions = {}

Additional discovery options

Returns

Promise<Scaffold[]>

Matching scaffolds

Released under the Apache-2.0 License.