Class: StoneFactory<TEvent, UResponse>

StoneFactory.

This class provides a fluent interface for building Stone applications. It is responsible for creating and running the main application by resolving the appropriate adapter from the provided blueprint. It handles the core setup of the application.

Template

UResponse

Type Parameters

TEvent

TEvent extends IncomingEvent

UResponse

UResponse extends OutgoingResponse

Methods

configure()

configure(configuration): this;

Configure the application using the blueprint resolver. Use this method to add custom configurations to the application.

Parameters

configuration

The user-defined blueprint configuration.

FunctionalConfiguration | Partial<Record<"configure" | "afterConfigure", FunctionalConfiguration>>

Returns

this

The current StoneFactory instance.

---

handle()

handle<ExecutionResultType>(handler): Promise<ExecutionResultType>;

Handle application events. This method is a shorthand for running the application with the provided event handler.

Type Parameters

ExecutionResultType

ExecutionResultType = unknown

Parameters

handler

MixedEventHandler<TEvent, unknown>

The application event handler function.

Returns

Promise<ExecutionResultType>

The platform-specific response.

---

run()

run<ExecutionResultType>(): Promise<ExecutionResultType>;

Run the application. Populates the blueprint via introspection and runs the application.

Type Parameters

ExecutionResultType

ExecutionResultType = unknown

Returns

Promise<ExecutionResultType>

The platform-specific response.

---

create()

static create<TEvent, UResponse>(options): StoneFactory<TEvent, UResponse>;

Create a new StoneFactory instance.

Type Parameters

TEvent

TEvent extends IncomingEvent

UResponse

UResponse extends OutgoingResponse

Parameters

options

StoneFactoryOptions = {}

The options to create the StoneFactory.

Returns

StoneFactory<TEvent, UResponse>

A new StoneFactory instance.

Example

const stone = StoneFactory.create({ modules: [/* your modules */] });