@dxos/app-framework - v0.15.0
    Preparing search index...

    Type Alias MakerOptions<Requires, Extra, Props, Options>

    Options accepted by makers built with moduleMaker.

    type MakerOptions<
        Requires extends readonly AnyTag[] = readonly [],
        Extra extends readonly AnyTag[] = readonly [],
        Props = void,
        Options = Props,
    > = {
        activatesOn?: Events;
        environments?: readonly Environment[];
        name?: string;
        props?: (options: Options) => Props;
        provides?: Extra;
        requires?: Requires;
    }

    Type Parameters

    • Requires extends readonly AnyTag[] = readonly []
    • Extra extends readonly AnyTag[] = readonly []
    • Props = void
    • Options = Props
    Index

    Properties

    activatesOn? environments? name? props? provides? requires?

    Properties

    activatesOn?: Events

    Activates when this runtime event fires instead of during the dependency pass.

    environments?: readonly Environment[]

    Conditions this module loads under (literal array); omitted means every condition.

    name?: string

    Overrides the default module name (used to derive the module id).

    props?: (options: Options) => Props

    Maps plugin options to the body's props; omit when they coincide.

    provides?: Extra

    Additional capabilities the body contributes beyond the maker's default.

    requires?: Requires

    Capabilities the body accesses via yield*.

    Settings

    Member Visibility

    On This Page

    Properties