@ts-ast-parser/core
Version:
Reflects a simplified version of the TypeScript AST for generating documentation
43 lines • 1.57 kB
TypeScript
import type { PropertyLikeNode, SymbolWithContext } from '../utils/types.js';
import type { Field, ModifierType } from '../models/member.js';
import type { ProjectContext } from '../project-context.js';
import type { ReflectedNode } from '../reflected-node.js';
import { MemberKind } from '../models/member-kind.js';
import { DecoratorNode } from './decorator-node.js';
import { CommentNode } from './comment-node.js';
import type { Type } from '../models/type.js';
/**
* Represents the reflected node of a property declaration
*/
export declare class PropertyNode implements ReflectedNode<Field, PropertyLikeNode> {
private readonly _node;
private readonly _nodeContext;
private readonly _context;
private readonly _jsDoc;
constructor(node: PropertyLikeNode, nodeContext: SymbolWithContext | null, context: ProjectContext);
getName(): string;
getKind(): MemberKind.Property;
getTSNode(): PropertyLikeNode;
getContext(): ProjectContext;
getLine(): number;
getType(): ReflectedNode<Type>;
getDefault(): unknown;
getModifier(): ModifierType | null;
getJSDoc(): CommentNode;
getDecorators(): DecoratorNode[];
isOptional(): boolean;
isStatic(): boolean;
isReadOnly(): boolean;
isWriteOnly(): boolean;
isAbstract(): boolean;
isInherited(): boolean;
overrides(): boolean;
/**
* Serializes the reflected node
*
* @returns The reflected node as a serializable object
*/
serialize(): Field;
private _getAccessors;
}
//# sourceMappingURL=property-node.d.ts.map