Function: defineStoneApp()

Defines a Stone app using a function-based, factory-based or class-based main handler.

Param

A function, factory function or class constructor for the main page.

Param

Optional application-level configuration.

Param

Additional blueprints to merge.

Call Signature

function defineStoneApp<U>(
   module, 
   options?, 
blueprints?): StoneBlueprint<U>;

Declares a complete Stone application blueprint using a function-based event handler.

Type Parameters

U

U extends IncomingEvent = IncomingEvent

Parameters

module

FunctionalEventHandler<U>

A function as an event handler.

options?

Partial<AppConfig<U, OutgoingResponse>> & object

Application-level configuration.

blueprints?

StoneBlueprint<any, any> & Record<string, any>[]

Additional partial blueprints to merge.

Returns

StoneBlueprint<U>

A fully merged Stone blueprint.

Param

A function, factory function or class constructor for the main page.

Param

Optional application-level configuration.

Param

Additional blueprints to merge.

Call Signature

function defineStoneApp<U>(
   module, 
   options, 
blueprints?): StoneBlueprint<U>;

Declares a complete Stone application blueprint using a factory-based event handler.

Type Parameters

U

U extends IncomingEvent = IncomingEvent

Parameters

module

FactoryEventHandler<U>

A factory function that returns an event handler.

options

Partial<AppConfig<U, OutgoingResponse>> & object

Application-level configuration with { isFactory: true }.

blueprints?

StoneBlueprint<any, any> & Record<string, any>[]

Additional partial blueprints to merge.

Returns

StoneBlueprint<U>

A fully merged Stone blueprint.

Param

A function, factory function or class constructor for the main page.

Param

Optional application-level configuration.

Param

Additional blueprints to merge.

Call Signature

function defineStoneApp<U>(
   module, 
   options, 
blueprints?): StoneBlueprint<U>;

Declares a complete Stone application blueprint using a class-based event handler.

Type Parameters

U

U extends IncomingEvent = IncomingEvent

Parameters

module

EventHandlerClass<U>

A class constructor for the event handler.

options

Partial<AppConfig<U, OutgoingResponse>> & object

Application-level configuration with { isClass: true }.

blueprints?

StoneBlueprint<any, any> & Record<string, any>[]

Additional partial blueprints to merge.

Returns

StoneBlueprint<U>

A fully merged Stone blueprint.

Param

A function, factory function or class constructor for the main page.

Param

Optional application-level configuration.

Param

Additional blueprints to merge.

Call Signature

function defineStoneApp<U>(options?, blueprints?): StoneBlueprint<U>;

Defines a Stone app without a main handler (router-only).

Type Parameters

U

U extends IncomingEvent = IncomingEvent

Parameters

options?

Partial<AppConfig<U, OutgoingResponse>>

Application-level configuration.

blueprints?

StoneBlueprint<any, any> & Record<string, any>[]

Additional partial blueprints to merge.

Returns

StoneBlueprint<U>

A fully merged Stone blueprint.

Param

A function, factory function or class constructor for the main page.

Param

Optional application-level configuration.

Param

Additional blueprints to merge.