Skip to main content

User Scripts Port (ports)

Classes​

UserScriptsPort​

import { UserScriptsPort } from '@hexajs-dev/ports';
class UserScriptsPort { ... }

Methods​

configureWorld()

configureWorld(properties: ConfigureWorldProperties): Promise<void>

getScripts()

getScripts(filter?: GetScriptsFilter): Promise<HexaWebUserScriptOptions[]>

register()

register(scripts: HexaWebUserScriptOptions[]): Promise<void>

unregister()

unregister(filter?: UnregisterFilter): Promise<void>

Supporting Types​

ConfigureWorldProperties​

interface ConfigureWorldProperties {
  csp?: string;
  messaging?: boolean;
}

GetScriptsFilter​

interface GetScriptsFilter {
  ids?: string[];
}

UnregisterFilter​

interface UnregisterFilter {
  ids?: string[];
}