Skip to content

Commit

Permalink
fixup! hide event interfaces from API docs
Browse files Browse the repository at this point in the history
Signed-off-by: Miroslav Bajtoš <[email protected]>
  • Loading branch information
bajtos committed Jun 9, 2020
1 parent 1c2feac commit 06abcdf
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 1 deletion.
4 changes: 3 additions & 1 deletion packages/context/src/binding.ts
Original file line number Diff line number Diff line change
Expand Up @@ -874,7 +874,9 @@ export class Binding<T = BoundValue> extends EventEmitter {
}

/**
* Type definitions for events emitted by Binding classes.
* Type definitions for events emitted by Binding instances.
*
* @internal Marked as internal to avoid api-extractor/api-documenter bug https://github.com/microsoft/rushstack/issues/1921
*/
export interface Binding {
/**
Expand Down
5 changes: 5 additions & 0 deletions packages/context/src/context-view.ts
Original file line number Diff line number Diff line change
Expand Up @@ -296,6 +296,11 @@ export function createViewGetter<T = unknown>(
return view.asGetter(session);
}

/**
* Type definitions for events emitted by ContextView instances.
*
* @internal Marked as internal to avoid api-extractor/api-documenter bug https://github.com/microsoft/rushstack/issues/1921
*/
export interface ContextView {
/**
* The "bind" event is emitted when a new binding is added to the view.
Expand Down
5 changes: 5 additions & 0 deletions packages/context/src/context.ts
Original file line number Diff line number Diff line change
Expand Up @@ -880,6 +880,11 @@ export class Context extends EventEmitter {
}
}

/**
* Type definitions for events emitted by Context instances.
*
* @internal Marked as internal to avoid api-extractor/api-documenter bug https://github.com/microsoft/rushstack/issues/1921
*/
export interface Context {
/**
* The "bind" event is emitted when a new binding is added to the context.
Expand Down

0 comments on commit 06abcdf

Please sign in to comment.