Skip to content

Commit

Permalink
Merge pull request #268 from matrix-org/hs/fix-docs-opts
Browse files Browse the repository at this point in the history
Fix documentation for opts
  • Loading branch information
Half-Shot authored Oct 30, 2020
2 parents 298c164 + 5100eef commit fe1f1a9
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 3 deletions.
1 change: 1 addition & 0 deletions changelog.d/268.doc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Render various opts objects in the documentation that were missed last time
4 changes: 2 additions & 2 deletions src/bridge.ts
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ const INTENT_CULL_EVICT_AFTER_MS = 1000 * 60 * 15; // 15 minutes
export const BRIDGE_PING_EVENT_TYPE = "org.matrix.bridge.ping";
export const BRIDGE_PING_TIMEOUT_MS = 60000;

interface BridgeController {
export interface BridgeController {
/**
* The bridge will invoke when an event has been received from the HS.
*/
Expand Down Expand Up @@ -112,7 +112,7 @@ interface BridgeController {

type PossiblePromise<T> = T|Promise<T>;

interface BridgeOpts {
export interface BridgeOpts {
/**
* Application service registration object or path to the registration file.
*/
Expand Down
2 changes: 1 addition & 1 deletion src/components/cli.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ import * as logging from "./logging";

const log = logging.get("cli");

interface CliOpts<ConfigType extends Record<string, unknown>> {
export interface CliOpts<ConfigType extends Record<string, unknown>> {
run: (port: number, config: ConfigType|null, registration: AppServiceRegistration|null) => void;
onConfigChanged?: (config: ConfigType) => void,
generateRegistration?: (reg: AppServiceRegistration, cb: (finalReg: AppServiceRegistration) => void) => void;
Expand Down

0 comments on commit fe1f1a9

Please sign in to comment.