marcel/mermaid
1
0
Fork 0
mirror of https://github.com/mermaid-js/mermaid.git synced 2025-09-21 16:29:40 +02:00
Code Issues Packages Projects Releases Wiki Activity

add tsdoc comments

Browse Source
This commit is contained in:
Justin Greywolf
2023-08-15 11:02:06 -07:00
parent 9a9abac5b1
commit bbaab54ec9
1 changed files with 28 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
packages/mermaid/src/diagrams/class/classTypes.ts
View File

@@ -16,13 +16,32 @@ export interface ClassNode {
tooltip?: string; tooltip?: string;
} }
export type Visibility = '#' | '+' | '~' | '-' | '';
export const visibilityValues = ['#', '+', '~', '-', ''];
/**
* Parses and stores class diagram member variables/methods.
*
*/
export class ClassMember { export class ClassMember {
id!: string; id!: string;
cssStyle!: string; cssStyle!: string;
memberType!: 'method' | 'attribute'; memberType!: 'method' | 'attribute';
visibility!: string; visibility!: Visibility;
/**
* denote if static or to determine which css class to apply to the node
* @defaultValue ''
*/
classifier!: string; classifier!: string;
/**
* parameters for method
* @defaultValue ''
*/
parameters!: string; parameters!: string;
/**
* return type for method
* @defaultValue ''
*/
returnType!: string; returnType!: string;
constructor(input: string, memberType: 'method' | 'attribute') { constructor(input: string, memberType: 'method' | 'attribute') {
@@ -57,7 +76,12 @@ export class ClassMember {
const methodRegEx = /([#+~-])?(.+)\((.*)\)([\s$*])?(.*)([$*])?/; const methodRegEx = /([#+~-])?(.+)\((.*)\)([\s$*])?(.*)([$*])?/;
const match = input.match(methodRegEx); const match = input.match(methodRegEx);
if (match) { if (match) {
this.visibility = match[1] ? match[1].trim() : ''; const detectedVisibility = match[1] ? match[1].trim() : '';
if (visibilityValues.includes(detectedVisibility)) {
this.visibility = detectedVisibility as Visibility;
}
this.id = match[2].trim(); this.id = match[2].trim();
this.parameters = match[3] ? match[3].trim() : ''; this.parameters = match[3] ? match[3].trim() : '';
potentialClassifier = match[4] ? match[4].trim() : ''; potentialClassifier = match[4] ? match[4].trim() : '';
@@ -76,8 +100,8 @@ export class ClassMember {
const firstChar = input.substring(0, 1); const firstChar = input.substring(0, 1);
const lastChar = input.substring(length - 1); const lastChar = input.substring(length - 1);
if (firstChar.match(/[#+~-]/)) { if (visibilityValues.includes(firstChar)) {
this.visibility = firstChar; this.visibility = firstChar as Visibility;
} }
if (lastChar.match(/[*?]/)) { if (lastChar.match(/[*?]/)) {