UNPKG

1.54 kBTypeScriptView Raw
1import { ModifierTagSet } from './ModifierTagSet';
2/**
3 * Extends the ModifierTagSet base class with getters for modifiers that
4 * are part of the standardized core tags for TSDoc.
5 */
6export declare class StandardModifierTagSet extends ModifierTagSet {
7 /**
8 * Returns true if the `@alpha` modifier tag was specified.
9 */
10 isAlpha(): boolean;
11 /**
12 * Returns true if the `@beta` modifier tag was specified.
13 */
14 isBeta(): boolean;
15 /**
16 * Returns true if the `@eventProperty` modifier tag was specified.
17 */
18 isEventProperty(): boolean;
19 /**
20 * Returns true if the `@experimental` modifier tag was specified.
21 */
22 isExperimental(): boolean;
23 /**
24 * Returns true if the `@internal` modifier tag was specified.
25 */
26 isInternal(): boolean;
27 /**
28 * Returns true if the `@override` modifier tag was specified.
29 */
30 isOverride(): boolean;
31 /**
32 * Returns true if the `@packageDocumentation` modifier tag was specified.
33 */
34 isPackageDocumentation(): boolean;
35 /**
36 * Returns true if the `@public` modifier tag was specified.
37 */
38 isPublic(): boolean;
39 /**
40 * Returns true if the `@readonly` modifier tag was specified.
41 */
42 isReadonly(): boolean;
43 /**
44 * Returns true if the `@sealed` modifier tag was specified.
45 */
46 isSealed(): boolean;
47 /**
48 * Returns true if the `@virtual` modifier tag was specified.
49 */
50 isVirtual(): boolean;
51}
52//# sourceMappingURL=StandardModifierTagSet.d.ts.map
\No newline at end of file