Class ProxyModule

Hierarchy

BaseEmitter<ProxyModuleParams, ModuleEventData>
- ProxyModule

Implements

Module<ModuleParams, ModuleEventData>

Index

Constructors

constructor

new ProxyModule(params): ProxyModule
Parameters
- params: ProxyModuleParams
Returns ProxyModule
Overrides BaseEmitter.constructor
- Defined in modules/packages/bridge/packages/module-resolver/dist/types/ProxyModule.d.ts:15

Properties

eventData

eventData: ModuleEventData

`Readonly` params

params: ProxyModuleParams

`Readonly` upResolver

upResolver: CompositeModuleResolver

`Static` `Optional` defaultLogger

defaultLogger?: Logger

Accessors

address

get address(): string
Returns string
Implementation of Module.address
- Defined in modules/packages/bridge/packages/module-resolver/dist/types/ProxyModule.d.ts:16

bridge

get bridge(): BridgeModule<BridgeParams<SchemaFields & PayloadFields & {
    archivist?: ArchivistModuleConfig;
    name?: string;
    paging?: Record<string, {
        size?: number;
    }>;
    schema: string;
    security?: {
        allowAnonymous?: boolean;
        allowed?: Record<string, (string | CosigningAddressSet)[]>;
        disallowed?: Record<string, string[]>;
    };
    storeQueries?: boolean;
} & Omit<Omit<SchemaFields & PayloadFields & {
    archivist?: ArchivistModuleConfig;
    name?: string;
    paging?: Record<string, {
        size?: number;
    }>;
    schema: "network.xyo.bridge.config";
    security?: {
        allowAnonymous?: boolean;
        allowed?: Record<string, (string | CosigningAddressSet)[]>;
        disallowed?: Record<string, string[]>;
    };
    storeQueries?: boolean;
} & Omit<{
    discoverCache?: true | CacheConfig;
    schema: "network.xyo.bridge.config";
}, "schema">, "schema"> & {
    schema: string;
}, "schema">>, ModuleEventData, Module<ModuleParams<SchemaFields & PayloadFields & {
    archivist?: ArchivistModuleConfig;
    name?: string;
    paging?: Record<string, {
        size?: number;
    }>;
    schema: string;
    security?: {
        allowAnonymous?: boolean;
        allowed?: Record<string, (string | CosigningAddressSet)[]>;
        disallowed?: Record<string, string[]>;
    };
    storeQueries?: boolean;
} & Omit<Omit<SchemaFields & PayloadFields & {
    archivist?: ArchivistModuleConfig;
    name?: string;
    paging?: Record<string, {
        size?: number;
    }>;
    schema: "network.xyo.module.config";
    security?: {
        allowAnonymous?: boolean;
        allowed?: Record<string, (string | CosigningAddressSet)[]>;
        disallowed?: Record<string, string[]>;
    };
    storeQueries?: boolean;
} & Omit<undefined, "schema">, "schema"> & {
    schema: string;
}, "schema">, undefined>, ModuleEventData>>
Returns BridgeModule<BridgeParams<SchemaFields & PayloadFields & {
    archivist?: ArchivistModuleConfig;
    name?: string;
    paging?: Record<string, {
        size?: number;
    }>;
    schema: string;
    security?: {
        allowAnonymous?: boolean;
        allowed?: Record<string, (string | CosigningAddressSet)[]>;
        disallowed?: Record<string, string[]>;
    };
    storeQueries?: boolean;
} & Omit<Omit<SchemaFields & PayloadFields & {
    archivist?: ArchivistModuleConfig;
    name?: string;
    paging?: Record<string, {
        size?: number;
    }>;
    schema: "network.xyo.bridge.config";
    security?: {
        allowAnonymous?: boolean;
        allowed?: Record<string, (string | CosigningAddressSet)[]>;
        disallowed?: Record<string, string[]>;
    };
    storeQueries?: boolean;
} & Omit<{
    discoverCache?: true | CacheConfig;
    schema: "network.xyo.bridge.config";
}, "schema">, "schema"> & {
    schema: string;
}, "schema">>, ModuleEventData, Module<ModuleParams<SchemaFields & PayloadFields & {
    archivist?: ArchivistModuleConfig;
    name?: string;
    paging?: Record<string, {
        size?: number;
    }>;
    schema: string;
    security?: {
        allowAnonymous?: boolean;
        allowed?: Record<string, (string | CosigningAddressSet)[]>;
        disallowed?: Record<string, string[]>;
    };
    storeQueries?: boolean;
} & Omit<Omit<SchemaFields & PayloadFields & {
    archivist?: ArchivistModuleConfig;
    name?: string;
    paging?: Record<string, {
        size?: number;
    }>;
    schema: "network.xyo.module.config";
    security?: {
        allowAnonymous?: boolean;
        allowed?: Record<string, (string | CosigningAddressSet)[]>;
        disallowed?: Record<string, string[]>;
    };
    storeQueries?: boolean;
} & Omit<undefined, "schema">, "schema"> & {
    schema: string;
}, "schema">, undefined>, ModuleEventData>>
- Defined in modules/packages/bridge/packages/module-resolver/dist/types/ProxyModule.d.ts:17

config

get config(): SchemaFields & PayloadFields & {
    archivist?: ArchivistModuleConfig;
    name?: string;
    paging?: Record<string, {
        size?: number;
    }>;
    schema: "network.xyo.module.config";
    security?: {
        allowAnonymous?: boolean;
        allowed?: Record<string, (string | CosigningAddressSet)[]>;
        disallowed?: Record<string, string[]>;
    };
    storeQueries?: boolean;
} & Omit<undefined, "schema">
Returns SchemaFields & PayloadFields & {
    archivist?: ArchivistModuleConfig;
    name?: string;
    paging?: Record<string, {
        size?: number;
    }>;
    schema: "network.xyo.module.config";
    security?: {
        allowAnonymous?: boolean;
        allowed?: Record<string, (string | CosigningAddressSet)[]>;
        disallowed?: Record<string, string[]>;
    };
    storeQueries?: boolean;
} & Omit<undefined, "schema">
Implementation of Module.config
- Defined in modules/packages/bridge/packages/module-resolver/dist/types/ProxyModule.d.ts:77

downResolver

get downResolver(): ModuleResolver
Returns ModuleResolver
Implementation of Module.downResolver
- Defined in modules/packages/bridge/packages/module-resolver/dist/types/ProxyModule.d.ts:78

`Protected` logger

get logger(): Logger | Console
Returns Logger | Console
Inherited from BaseEmitter.logger
- Defined in protocol/packages/core/dist/types/lib/Base.d.ts:23

queries

get queries(): string[]
Returns string[]
Implementation of Module.queries
- Defined in modules/packages/bridge/packages/module-resolver/dist/types/ProxyModule.d.ts:79

Methods

clearListeners

clearListeners(eventNames): void
Parameters
- eventNames: keyof ModuleEventData | (keyof ModuleEventData)[]
Returns void
Implementation of Module.clearListeners

Inherited from BaseEmitter.clearListeners
- Defined in modules/packages/module/packages/abstract/dist/types/BaseEmitter.d.ts:7

emit

emit<TEventName, TEventArgs>(eventName, eventArgs): Promise<void>
Type Parameters
- TEventName extends keyof ModuleEventData = keyof ModuleEventData
- TEventArgs extends EventArgs = ModuleEventData[TEventName]
Parameters
- eventName: TEventName
- eventArgs: TEventArgs
Returns Promise<void>
Implementation of Module.emit

Inherited from BaseEmitter.emit
- Defined in modules/packages/module/packages/abstract/dist/types/BaseEmitter.d.ts:8

emitSerial

emitSerial<TEventName, TEventArgs>(eventName, eventArgs): Promise<void>
Type Parameters
- TEventName extends keyof ModuleEventData = keyof ModuleEventData
- TEventArgs extends EventArgs = ModuleEventData[TEventName]
Parameters
- eventName: TEventName
- eventArgs: TEventArgs
Returns Promise<void>
Implementation of Module.emitSerial

Inherited from BaseEmitter.emitSerial
- Defined in modules/packages/module/packages/abstract/dist/types/BaseEmitter.d.ts:9

listenerCount

listenerCount(eventNames): number
Parameters
- eventNames: keyof ModuleEventData | (keyof ModuleEventData)[]
Returns number
Implementation of Module.listenerCount

Inherited from BaseEmitter.listenerCount
- Defined in modules/packages/module/packages/abstract/dist/types/BaseEmitter.d.ts:10

off

off<TEventName>(eventNames, listener): void
Type Parameters
- TEventName extends keyof ModuleEventData
Parameters
- eventNames: TEventName | TEventName[]
- listener: EventListener<ModuleEventData[TEventName]>
Returns void
Implementation of Module.off

Inherited from BaseEmitter.off
- Defined in modules/packages/module/packages/abstract/dist/types/BaseEmitter.d.ts:11

offAny

offAny(listener): void
Parameters
- listener: EventAnyListener<EventArgs>
Returns void
Implementation of Module.offAny

Inherited from BaseEmitter.offAny
- Defined in modules/packages/module/packages/abstract/dist/types/BaseEmitter.d.ts:12

on

on<TEventName>(eventNames, listener): (() => void)
Type Parameters
- TEventName extends keyof ModuleEventData
Parameters
- eventNames: TEventName | TEventName[]
- listener: EventListener<ModuleEventData[TEventName]>
Returns (() => void)
- - (): void
  - Returns void
Implementation of Module.on

Inherited from BaseEmitter.on
- Defined in modules/packages/module/packages/abstract/dist/types/BaseEmitter.d.ts:13

onAny

onAny(listener): (() => void)
Parameters
- listener: EventAnyListener<EventArgs>
Returns (() => void)
- - (): void
  - Returns void
Implementation of Module.onAny

Inherited from BaseEmitter.onAny
- Defined in modules/packages/module/packages/abstract/dist/types/BaseEmitter.d.ts:14

once

once<TEventName>(eventName, listener): (() => void)
Type Parameters
- TEventName extends keyof ModuleEventData
Parameters
- eventName: TEventName
- listener: EventListener<ModuleEventData[TEventName]>
Returns (() => void)
- - (): void
  - Returns void
Implementation of Module.once

Inherited from BaseEmitter.once
- Defined in modules/packages/module/packages/abstract/dist/types/BaseEmitter.d.ts:15

query

query<T>(query, payloads?): Promise<ModuleQueryResult<SchemaFields & PayloadFields & {
schema: string;
}>>
Type Parameters
- T extends SchemaFields & PayloadFields & BoundWitnessFields & {
      query: string;
      resultSet?: string;
      schema: "network.xyo.boundwitness";
  } = SchemaFields & PayloadFields & BoundWitnessFields & {
      query: string;
      resultSet?: string;
      schema: "network.xyo.boundwitness";
  }
Parameters
- query: T
- Optional payloads: (SchemaFields & PayloadFields & {
  schema: string;
  })[]
Returns Promise<ModuleQueryResult<SchemaFields & PayloadFields & {
schema: string;
}>>
Implementation of Module.query
- Defined in modules/packages/bridge/packages/module-resolver/dist/types/ProxyModule.d.ts:80

queryable

queryable(query, payloads?, queryConfig?): Promise<boolean>
Parameters
- query: SchemaFields & PayloadFields & BoundWitnessFields & {
      query: string;
      resultSet?: string;
      schema: "network.xyo.boundwitness";
  }
- Optional payloads: (SchemaFields & PayloadFields & {
  schema: string;
  })[]
- Optional queryConfig: SchemaFields & PayloadFields & {
      archivist?: ArchivistModuleConfig;
      name?: string;
      paging?: Record<string, {
          size?: number;
      }>;
      schema: "network.xyo.module.config";
      security?: {
          allowAnonymous?: boolean;
          allowed?: Record<string, (string | CosigningAddressSet)[]>;
          disallowed?: Record<string, string[]>;
      };
      storeQueries?: boolean;
  } & Omit<undefined, "schema">
Returns Promise<boolean>
Implementation of Module.queryable
- Defined in modules/packages/bridge/packages/module-resolver/dist/types/ProxyModule.d.ts:81

resolve

resolve(filter?): Promise<Module<ModuleParams<SchemaFields & PayloadFields & {
    archivist?: ArchivistModuleConfig;
    name?: string;
    paging?: Record<string, {
        size?: number;
    }>;
    schema: string;
    security?: {
        allowAnonymous?: boolean;
        allowed?: Record<string, (string | CosigningAddressSet)[]>;
        disallowed?: Record<string, string[]>;
    };
    storeQueries?: boolean;
} & Omit<Omit<SchemaFields & PayloadFields & {
    archivist?: ArchivistModuleConfig;
    name?: string;
    paging?: Record<string, {
        size?: number;
    }>;
    schema: "network.xyo.module.config";
    security?: {
        allowAnonymous?: boolean;
        allowed?: Record<string, (string | CosigningAddressSet)[]>;
        disallowed?: Record<string, string[]>;
    };
    storeQueries?: boolean;
} & Omit<undefined, "schema">, "schema"> & {
    schema: string;
}, "schema">, undefined>, ModuleEventData>[]>
Parameters
- Optional filter: ModuleFilter
Returns Promise<Module<ModuleParams<SchemaFields & PayloadFields & {
    archivist?: ArchivistModuleConfig;
    name?: string;
    paging?: Record<string, {
        size?: number;
    }>;
    schema: string;
    security?: {
        allowAnonymous?: boolean;
        allowed?: Record<string, (string | CosigningAddressSet)[]>;
        disallowed?: Record<string, string[]>;
    };
    storeQueries?: boolean;
} & Omit<Omit<SchemaFields & PayloadFields & {
    archivist?: ArchivistModuleConfig;
    name?: string;
    paging?: Record<string, {
        size?: number;
    }>;
    schema: "network.xyo.module.config";
    security?: {
        allowAnonymous?: boolean;
        allowed?: Record<string, (string | CosigningAddressSet)[]>;
        disallowed?: Record<string, string[]>;
    };
    storeQueries?: boolean;
} & Omit<undefined, "schema">, "schema"> & {
    schema: string;
}, "schema">, undefined>, ModuleEventData>[]>
- Defined in modules/packages/bridge/packages/module-resolver/dist/types/ProxyModule.d.ts:82

Class ProxyModule

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

params: ProxyModuleParams

Returns ProxyModule

Properties

eventData

Readonly params

Readonly upResolver

Static Optional defaultLogger

Accessors

address

Returns string

bridge

config

downResolver

Returns ModuleResolver

Protected logger

Returns Logger | Console

queries

Returns string[]

Methods

clearListeners

Parameters

eventNames: keyof ModuleEventData | (keyof ModuleEventData)[]

Returns void

emit

Type Parameters

TEventName extends keyof ModuleEventData = keyof ModuleEventData

TEventArgs extends EventArgs = ModuleEventData[TEventName]

Parameters

eventName: TEventName

eventArgs: TEventArgs

Returns Promise<void>

emitSerial

Type Parameters

TEventName extends keyof ModuleEventData = keyof ModuleEventData

TEventArgs extends EventArgs = ModuleEventData[TEventName]

Parameters

eventName: TEventName

eventArgs: TEventArgs

Returns Promise<void>

listenerCount

Parameters

eventNames: keyof ModuleEventData | (keyof ModuleEventData)[]

Returns number

off

Type Parameters

TEventName extends keyof ModuleEventData

Parameters

eventNames: TEventName | TEventName[]

listener: EventListener<ModuleEventData[TEventName]>

Returns void

offAny

Parameters

listener: EventAnyListener<EventArgs>

Returns void

on

Type Parameters

TEventName extends keyof ModuleEventData

Parameters

eventNames: TEventName | TEventName[]

listener: EventListener<ModuleEventData[TEventName]>

Returns (() => void)

Returns void

onAny

Parameters

listener: EventAnyListener<EventArgs>

Returns (() => void)

Returns void

once

Type Parameters

`Readonly` params

`Readonly` upResolver

`Static` `Optional` defaultLogger

`Protected` logger

T extends SchemaFields & PayloadFields & BoundWitnessFields & {
query: string;
resultSet?: string;
schema: "network.xyo.boundwitness";
} = SchemaFields & PayloadFields & BoundWitnessFields & {
query: string;
resultSet?: string;
schema: "network.xyo.boundwitness";
}

`Optional` payloads: (SchemaFields & PayloadFields & {
schema: string;
})[]

Returns Promise<ModuleQueryResult<SchemaFields & PayloadFields & {
schema: string;
}>>

query: SchemaFields & PayloadFields & BoundWitnessFields & {
query: string;
resultSet?: string;
schema: "network.xyo.boundwitness";
}

`Optional` payloads: (SchemaFields & PayloadFields & {
schema: string;
})[]

`Optional` filter: ModuleFilter