eve/dist/src/compiled/@workflow/core/runtime/world.d.ts

Filesystem-first framework for durable backend AI agents that run anywhere.

import type { World } from '#compiled/@workflow/world/index.js';
export type WorldFactoryModule = {
    createWorld?: () => World | Promise<World>;
    /** @deprecated World packages should export `createWorld()` instead. */
    createLocalWorld?: () => World | Promise<World>;
    /** @deprecated World packages should export `createWorld()` instead. */
    createVercelWorld?: () => World | Promise<World>;
    default?: (() => World | Promise<World>) | World;
};
/**
 * Create a World instance from a world factory module. Shared by
 * `createWorld()` (for the statically injected target world module) and
 * tooling that loads a world module dynamically (e.g. the Nitro dev
 * handler and `@workflow/world-testing`). Legacy world-specific factory
 * names are still accepted for compatibility, but world packages should
 * export `createWorld()`.
 */
export declare function createWorldFromModule(mod: WorldFactoryModule): World | Promise<World>;
/**
 * Create a new world instance from the statically imported target world module.
 *
 * Framework integrations alias `@workflow/core/runtime/world-target` to the
 * concrete world package at build time, so bundlers see a static import path
 * instead of tracing a runtime-built require/import expression.
 */
export declare const createWorld: () => Promise<World>;
export type WorldHandlers = Pick<World, 'createQueueHandler' | 'specVersion'>;
/**
 * Some functions from the world are needed at build time, but we do NOT want
 * to cache the world in those instances for general use, since we don't have
 * the correct environment variables set yet. This is a safe function to
 * call at build time, that only gives access to non-environment-bound world
 * functions. The only binding value should be the target world.
 * Once we migrate to a file-based configuration (workflow.config.ts), we should
 * be able to re-combine getWorld and getWorldHandlers into one singleton.
 */
export declare const getWorldHandlers: () => Promise<WorldHandlers>;
export declare const getWorld: () => Promise<World>;
/**
 * Reset the cached world instance. This should be called when environment
 * variables change and you need to reinitialize the world with new config.
 */
export declare const setWorld: (world: World | undefined) => void;
//# sourceMappingURL=world.d.ts.map