Skip to content
Designer Decisions

BuilderContext

A context object created by createBuilderContext() that exposes the BuilderOptions and collects eventual errors produced building the store.

export type BuilderContext = {
    options: () => BuilderOptions;
    hasErrors: () => boolean;
    errors: () => BuilderError[];
    addError: (error: BuilderError) => void;
};

Methods

༶ options()

Return Value: BuilderOptions

This function throws an error if no options were provided to the context via createBuilderContext().

༶ hasErrors()

Return Value: boolean indicating if errors occurred building the store.

༶ errors()

Return Value: BuilderError[] with any errors that occurred building the store.

༶ addError(error: BuilderError)

Parameters:

Usage

Use createBuilderContext() to create a BuilderContext.

const config = await loadConfig();
const context = createBuilderContext(config.store);
const builder = buildStaticStore(context);

When adding errors to the context you need to create a BuilderError first. You can do this by calling createBuilderUnexpectedError() with the exception.

import { createBuilderUnexpectedError } from '@noodlestan/designer-functions';


try {
    ...
} catch (error) {
    context.addError(createBuilderUnexpectedError({ error }));
}

See also