forked from stainless-api/rushstack
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathPluginFeature.ts
More file actions
68 lines (58 loc) · 1.81 KB
/
Copy pathPluginFeature.ts
File metadata and controls
68 lines (58 loc) · 1.81 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
// See LICENSE in the project root for license information.
import { TypeUuid } from '@rushstack/node-core-library';
/**
* This is an internal part of the plugin infrastructure.
*
* @remarks
* This object is the constructor parameter for API Documenter plugin features.
*
* @public
*/
export class PluginFeatureInitialization {
/** @internal */
public _context!: PluginFeatureContext;
/** @internal */
public constructor() {
// reserved for future use
}
}
/**
* Context object for {@link PluginFeature}.
* Exposes various services that can be used by a plugin.
*
* @public
*/
export class PluginFeatureContext {}
const uuidPluginFeature: string = '56876472-7134-4812-819e-533de0ee10e6';
/**
* The abstract base class for all API Documenter plugin features.
* @public
*/
export abstract class PluginFeature {
/**
* Exposes various services that can be used by a plugin.
*/
public context: PluginFeatureContext;
/**
* The subclass should pass the `initialization` through to the base class.
* Do not put custom initialization code in the constructor. Instead perform your initialization in the
* `onInitialized()` event function.
* @internal
*/
public constructor(initialization: PluginFeatureInitialization) {
// reserved for future expansion
this.context = initialization._context;
}
/**
* This event function is called after the feature is initialized, but before any processing occurs.
* @virtual
*/
public onInitialized(): void {
// (implemented by child class)
}
public static [Symbol.hasInstance](instance: object): boolean {
return TypeUuid.isInstanceOf(instance, uuidPluginFeature);
}
}
TypeUuid.registerClass(PluginFeature, uuidPluginFeature);