Magek Framework
    Preparing search index...

    Interface MagekApp

    MagekApp is the interface of the user-facing functions that the framework provides.

    interface MagekApp {
        start(projectPath: string): void;
        config: MagekConfig;
        configure(
            environment: string,
            configurator: (config: MagekConfig) => void,
        ): void;
        configureCurrentEnv(configurator: (config: MagekConfig) => void): void;
        entity<TEntity extends EntityInterface>(
            entityName: Class<TEntity>,
            entityID: UUID,
        ): Promise<TEntity | undefined>;
        readModel<TReadModel extends ReadModelInterface>(
            readModelClass: Class<TReadModel>,
        ): Searcher<TReadModel>;
        events(request: EventSearchParameters): Promise<EventSearchResponse[]>;
        entitiesIDs(
            entityTypeName: string,
            limit: number,
            afterCursor: Record<string, string> | undefined,
        ): Promise<PaginatedEntitiesIdsResult>;
        deleteEvent(parameters: EventDeleteParameters): Promise<boolean>;
        configuredEnvironments: Set<string>;
    }
    Index

    Methods

    start configure configureCurrentEnv entity readModel events entitiesIDs deleteEvent

    Properties

    config configuredEnvironments

    Methods

    Properties

    config: MagekConfig
    configuredEnvironments: Set<string>

    Settings

    Member Visibility

    On This Page

    Methods
    Properties