@microsoft/tsdoc
Version:
A parser for the TypeScript doc comment syntax
77 lines • 2.27 kB
JavaScript
// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
// See LICENSE in the project root for license information.
import { ModifierTagSet } from './ModifierTagSet';
import { StandardTags } from './StandardTags';
/**
* Extends the ModifierTagSet base class with getters for modifiers that
* are part of the standardized core tags for TSDoc.
*/
export class StandardModifierTagSet extends ModifierTagSet {
/**
* Returns true if the `@alpha` modifier tag was specified.
*/
isAlpha() {
return this.hasTag(StandardTags.alpha);
}
/**
* Returns true if the `@beta` modifier tag was specified.
*/
isBeta() {
return this.hasTag(StandardTags.beta);
}
/**
* Returns true if the `@eventProperty` modifier tag was specified.
*/
isEventProperty() {
return this.hasTag(StandardTags.eventProperty);
}
/**
* Returns true if the `@experimental` modifier tag was specified.
*/
isExperimental() {
return this.hasTag(StandardTags.experimental);
}
/**
* Returns true if the `@internal` modifier tag was specified.
*/
isInternal() {
return this.hasTag(StandardTags.internal);
}
/**
* Returns true if the `@override` modifier tag was specified.
*/
isOverride() {
return this.hasTag(StandardTags.override);
}
/**
* Returns true if the `@packageDocumentation` modifier tag was specified.
*/
isPackageDocumentation() {
return this.hasTag(StandardTags.packageDocumentation);
}
/**
* Returns true if the `@public` modifier tag was specified.
*/
isPublic() {
return this.hasTag(StandardTags.public);
}
/**
* Returns true if the `@readonly` modifier tag was specified.
*/
isReadonly() {
return this.hasTag(StandardTags.readonly);
}
/**
* Returns true if the `@sealed` modifier tag was specified.
*/
isSealed() {
return this.hasTag(StandardTags.sealed);
}
/**
* Returns true if the `@virtual` modifier tag was specified.
*/
isVirtual() {
return this.hasTag(StandardTags.virtual);
}
}
//# sourceMappingURL=StandardModifierTagSet.js.map