How to use the @microsoft/api-extractor/lib/definitions/ApiDocumentation.ReleaseTag.Beta function in @microsoft/api-extractor

To help you get started, we’ve selected a few @microsoft/api-extractor examples, based on popular ways it is used in public projects.

Secure your code as it's written. Use Snyk Code to scan source code in minutes - no build needed - and fix issues immediately.

github SimplrJS / ts-docs-gen / src / extractor / api-json-generator.ts View on Github external
type: apiMethod.returnType,
                description: apiMethod.documentation.returnsMessage
            };

            newNode = {
                kind: ApiJsonFile.convertKindToJson(apiMethod.kind),
                signature: apiMethod.getDeclarationLine(),
                accessModifier: apiMethod.accessModifier ? AccessModifier[apiMethod.accessModifier].toLowerCase() : "",
                isOptional: !!apiMethod.isOptional,
                isStatic: !!apiMethod.isStatic,
                returnValue: returnValueNode,
                parameters: apiMethod.documentation.parameters,
                deprecatedMessage: apiMethod.documentation.deprecatedMessage || [],
                summary: apiMethod.documentation.summary || [],
                remarks: apiMethod.documentation.remarks || [],
                isBeta: apiMethod.documentation.releaseTag === ReleaseTag.Beta
            };
        }

        if (refObject != null) {
            refObject[apiMethod.name] = newNode;
        }
    }
}