Interface BridgeModule<TParams, TEventData, TModule>

Type Parameters

TParams extends BridgeParams = BridgeParams
TEventData extends ModuleEventData = ModuleEventData
TModule extends Module<ModuleParams, TEventData> = Module<ModuleParams, TEventData>

Hierarchy

Bridge
Module<TParams, TEventData>
- BridgeModule

Implemented by

Properties

address

address: string

config

config: TParams["config"]

connect

connect: (() => Promisable<boolean, never>)

Type declaration

- (): Promisable<boolean, never>
- Returns Promisable<boolean, never>

disconnect

disconnect: (() => Promisable<boolean, never>)

Type declaration

- (): Promisable<boolean, never>
- Returns Promisable<boolean, never>

`Readonly` downResolver

downResolver: ModuleResolver

eventData

eventData: TEventData

params

params: TParams

queries

queries: string[]

query

query: (<T, TConf>(query, payloads?, queryConfig?) => Promisable<ModuleQueryResult<SchemaFields & PayloadFields & {
schema: string;
}>, never>)

Type declaration

- <T, TConf>(query, payloads?, queryConfig?): Promisable<ModuleQueryResult<SchemaFields & PayloadFields & {
  schema: string;
  }>, never>
- 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";
    }
  - TConf extends 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"> = 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">
  Parameters
  - query: T
  - Optional payloads: (SchemaFields & PayloadFields & {
    schema: string;
    })[]
  - Optional queryConfig: TConf
  Returns Promisable<ModuleQueryResult<SchemaFields & PayloadFields & {
  schema: string;
  }>, never>

queryable

queryable: (<T, TConf>(query, payloads?, queryConfig?) => Promisable<boolean, never>)

Type declaration

- <T, TConf>(query, payloads?, queryConfig?): Promisable<boolean, never>
- 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";
    }
  - TConf extends 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"> = 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">
  Parameters
  - query: T
  - Optional payloads: (SchemaFields & PayloadFields & {
    schema: string;
    })[]
  - Optional queryConfig: TConf
  Returns Promisable<boolean, never>

`Optional` start

start?: (() => Promisable<void, never>)

Type declaration

- (): Promisable<void, never>
- Returns Promisable<void, never>

`Readonly` upResolver

upResolver: ModuleResolver

Methods

clearListeners

clearListeners(eventNames): void
Parameters
- eventNames: keyof TEventData | (keyof TEventData)[]
Returns void
Inherited from Module.clearListeners
- Defined in modules/packages/module/packages/events/dist/types/model/Event.d.ts:12

emit

emit<TEventName>(eventName, eventArgs): Promise<void>
Type Parameters
- TEventName extends string | number | symbol
Parameters
- eventName: TEventName
- eventArgs: TEventData[TEventName]
Returns Promise<void>
Inherited from Module.emit
- Defined in modules/packages/module/packages/events/dist/types/model/Event.d.ts:13

emitSerial

emitSerial<TEventName>(eventName, eventArgs): Promise<void>
Type Parameters
- TEventName extends string | number | symbol
Parameters
- eventName: TEventName
- eventArgs: TEventData[TEventName]
Returns Promise<void>
Inherited from Module.emitSerial
- Defined in modules/packages/module/packages/events/dist/types/model/Event.d.ts:14

listenerCount

listenerCount(eventNames): number
Parameters
- eventNames: keyof TEventData | (keyof TEventData)[]
Returns number
Inherited from Module.listenerCount
- Defined in modules/packages/module/packages/events/dist/types/model/Event.d.ts:15

off

off<TEventName>(eventNames, listener): void
Type Parameters
- TEventName extends string | number | symbol
Parameters
- eventNames: TEventName | TEventName[]
- listener: EventListener<TEventData[TEventName]>
Returns void
Inherited from Module.off
- Defined in modules/packages/module/packages/events/dist/types/model/Event.d.ts:16

offAny

offAny(listener): void
Parameters
- listener: Promise<void> | EventAnyListener<EventArgs>
Returns void
Inherited from Module.offAny
- Defined in modules/packages/module/packages/events/dist/types/model/Event.d.ts:17

on

on<TEventName>(eventNames, listener): EventUnsubscribeFunction
Type Parameters
- TEventName extends string | number | symbol
Parameters
- eventNames: TEventName | TEventName[]
- listener: EventListener<TEventData[TEventName]>
Returns EventUnsubscribeFunction
Inherited from Module.on
- Defined in modules/packages/module/packages/events/dist/types/model/Event.d.ts:18

onAny

onAny(listener): EventUnsubscribeFunction
Parameters
- listener: EventAnyListener<EventArgs>
Returns EventUnsubscribeFunction
Inherited from Module.onAny
- Defined in modules/packages/module/packages/events/dist/types/model/Event.d.ts:19

once

once<TEventName>(eventName, listener): EventUnsubscribeFunction
Type Parameters
- TEventName extends string | number | symbol
Parameters
- eventName: TEventName
- listener: EventListener<TEventData[TEventName]>
Returns EventUnsubscribeFunction
Inherited from Module.once
- Defined in modules/packages/module/packages/events/dist/types/model/Event.d.ts:20

targetConfig

targetConfig(address): 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">
Parameters
- address: string
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">
- Defined in modules/packages/bridge/packages/model/dist/types/Bridge.d.ts:11

targetDiscover

targetDiscover(address?): Promisable<undefined | (SchemaFields & PayloadFields & {
schema: string;
})[], never>
Parameters
- Optional address: string
Returns Promisable<undefined | (SchemaFields & PayloadFields & {
schema: string;
})[], never>
- Defined in modules/packages/bridge/packages/model/dist/types/Bridge.d.ts:12

targetDownResolver

targetDownResolver(address?): TModule["downResolver"]
Parameters
- Optional address: string
Returns TModule["downResolver"]
- Defined in modules/packages/bridge/packages/model/dist/types/Bridge.d.ts:13

targetQueries

targetQueries(address): string[]
Parameters
- address: string
Returns string[]
- Defined in modules/packages/bridge/packages/model/dist/types/Bridge.d.ts:14

targetQuery

targetQuery(address, query, payloads?): Promisable<undefined | ModuleQueryResult<SchemaFields & PayloadFields & {
schema: string;
}>, never>
Parameters
- address: string
- query: SchemaFields & PayloadFields & QueryFields & {
  schema: string;
  }
- Optional payloads: (SchemaFields & PayloadFields & {
  schema: string;
  })[]
Returns Promisable<undefined | ModuleQueryResult<SchemaFields & PayloadFields & {
schema: string;
}>, never>
- Defined in modules/packages/bridge/packages/model/dist/types/Bridge.d.ts:15

targetQueryable

targetQueryable(address, query, payloads?, queryConfig?): Promisable<boolean, never>
Parameters
- address: string
- 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 Promisable<boolean, never>
- Defined in modules/packages/bridge/packages/model/dist/types/Bridge.d.ts:16

targetResolve

targetResolve(address, filter?): Promisable<TModule[], never>
Parameters
- address: string
- Optional filter: ModuleFilter
Returns Promisable<TModule[], never>
- Defined in modules/packages/bridge/packages/model/dist/types/Bridge.d.ts:17

Interface BridgeModule<TParams, TEventData, TModule>

Type Parameters

TParams extends BridgeParams = BridgeParams

TEventData extends ModuleEventData = ModuleEventData

TModule extends Module<ModuleParams, TEventData> = Module<ModuleParams, TEventData>

Hierarchy

Implemented by

Index

Properties

Methods

Properties

address

config

connect

Type declaration

Returns Promisable<boolean, never>

disconnect

Type declaration

Returns Promisable<boolean, never>

Readonly downResolver

eventData

params

queries

query

Type declaration

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; })[]

Optional queryConfig: TConf

Returns Promisable<ModuleQueryResult<SchemaFields & PayloadFields & { schema: string; }>, never>

queryable

Type declaration

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; })[]

Optional queryConfig: TConf

Returns Promisable<boolean, never>

Optional start

Type declaration

Returns Promisable<void, never>

Readonly upResolver

Methods

clearListeners

Parameters

eventNames: keyof TEventData | (keyof TEventData)[]

Returns void

emit

Type Parameters

TEventName extends string | number | symbol

Parameters

eventName: TEventName

eventArgs: TEventData[TEventName]

Returns Promise<void>

emitSerial

Type Parameters

TEventName extends string | number | symbol

Parameters

eventName: TEventName

eventArgs: TEventData[TEventName]

Returns Promise<void>

listenerCount

Parameters

eventNames: keyof TEventData | (keyof TEventData)[]

Returns number

off

Type Parameters

TEventName extends string | number | symbol

Parameters

eventNames: TEventName | TEventName[]

listener: EventListener<TEventData[TEventName]>

Returns void

offAny

Parameters

listener: Promise<void> | EventAnyListener<EventArgs>

Returns void

on

`Readonly` downResolver

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;
})[]

`Optional` queryConfig: TConf

Returns Promisable<ModuleQueryResult<SchemaFields & PayloadFields & {
schema: string;
}>, never>

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;
})[]

`Optional` queryConfig: TConf

`Optional` start

`Readonly` upResolver

`Optional` address: string

Returns Promisable<undefined | (SchemaFields & PayloadFields & {
schema: string;
})[], never>

`Optional` address: string

query: SchemaFields & PayloadFields & QueryFields & {
schema: string;
}

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

Returns Promisable<undefined | ModuleQueryResult<SchemaFields & PayloadFields & {
schema: string;
}>, never>

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

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

`Optional` filter: ModuleFilter