jsii-docgen

property name

readonly name: string;

method cleanup

cleanup: () => Promise<void>;

• Removes any internal working directories.

method forAssembly

static forAssembly: (
    assemblyName: string,
    assembliesDir: string
) => Promise<Documentation>;

• Create a Documentation object for a specific assembly from a directory of assemblies.

  Parameter assemblyName

  The assembly name.

  Parameter assembliesDir

  The directory containing the assemblies that comprise the type-system.

method forPackage

static forPackage: (
    target: string,
    options?: ForPackageDocumentationOptions
) => Promise<Documentation>;

• Create a Documentation object from a package installable by npm.

  Note that this method installs the target package to the local file-system. Make sure to call Documentation.cleanup once you are done rendering.

  Parameter target

  The target to install. This can either be a local path or a registry identifier (e.g @)

  Parameter options

  Additional options.

  Throws

  NoSpaceLeftOnDevice if the installation fails due to running out of disk space

  Throws

  NpmError if some npm command fails when preparing the working set

method forProject

static forProject: (
    root: string,
    options?: ForLocalPackageDocumentationOptions
) => Promise<Documentation>;

• Create a Documentation object from a local directory containing a node project.

  Parameter root

  The local directory path. Must contain a package.json file.

  Parameter options

  Additional options.

method listSubmodules

listSubmodules: () => Promise<readonly reflect.Submodule[]>;

• List all submodules in the assembly.

method toIndexMarkdown

toIndexMarkdown: (
    fileSuffix: string,
    options: RenderOptions
) => Promise<MarkdownDocument>;

method toJson

toJson: (options: RenderOptions) => Promise<Json<Schema>>;

• Generate markdown.

method toMarkdown

toMarkdown: (options: MarkdownRenderOptions) => Promise<MarkdownDocument>;

property CSHARP

static readonly CSHARP: Language;

• C#

property GO

static readonly GO: Language;

• Go

property JAVA

static readonly JAVA: Language;

• Java.

property name

readonly name: string;

property PYTHON

static readonly PYTHON: Language;

• Python.

property targetName

readonly targetName: string;

property TYPESCRIPT

static readonly TYPESCRIPT: Language;

• TypeScript.

method fromString

static fromString: (lang: string) => Language;

• Transform a literal string to the Language object.

  Throws an UnsupportedLanguageError if the language is not supported.

method isValidConfiguration

isValidConfiguration: (config: Record<string, unknown> | undefined) => boolean;

method toString

toString: () => string;

method values

static values: () => Language[];

constructor

constructor(options?: MarkdownOptions);

property EMPTY

static readonly EMPTY: MarkdownDocument;

• An empty markdown element.

method bold

static bold: (text: string) => string;

method bullet

bullet: (line: string) => void;

method code

code: (language: string, ...snippet: string[]) => void;

method docs

docs: (docs: DocsSchema, language?: Language) => void;

• Render a docs element into the markdown.

method italic

static italic: (text: string) => string;

method lines

lines: (...lines: string[]) => void;

method pre

static pre: (text: string) => string;

method quote

quote: (line: string) => void;

method removeNewlines

static removeNewlines: (line: string) => string;

• Remove newlines from markdown.

method render

render: (headerSize?: number) => string;

method sanitize

static sanitize: (line: string) => string;

• Sanitize markdown reserved characters from external input.

method section

section: (section: MarkdownDocument) => void;

method split

split: () => void;

method table

table: (data: string[][]) => void;

constructor

constructor(options: MarkdownRendererOptions);

method fromSchema

static fromSchema: (
    schema: Schema,
    options: MarkdownFormattingOptions
) => MarkdownDocument;

method fromSubmodules

static fromSubmodules: (
    submodules: readonly reflect.Submodule[],
    fileSuffix: string,
    options: MarkdownRendererOptions
) => MarkdownDocument;

method visitApiReference

visitApiReference: (
    apiRef: ApiReferenceSchema,
    header?: { title: string; id: string }
) => MarkdownDocument;

method visitClass

visitClass: (klass: ClassSchema) => MarkdownDocument;

method visitClasses

visitClasses: (classes: ClassSchema[]) => MarkdownDocument;

method visitConstant

visitConstant: (constant: PropertySchema) => MarkdownDocument;

method visitConstants

visitConstants: (constants: PropertySchema[]) => MarkdownDocument;

method visitConstruct

visitConstruct: (construct: ConstructSchema) => MarkdownDocument;

method visitConstructs

visitConstructs: (constructs: ConstructSchema[]) => MarkdownDocument;

method visitEnum

visitEnum: (enu: EnumSchema) => MarkdownDocument;

method visitEnumMember

visitEnumMember: (em: EnumMemberSchema) => MarkdownDocument;

method visitEnumMembers

visitEnumMembers: (enus: EnumMemberSchema[]) => MarkdownDocument;

method visitEnums

visitEnums: (enums: EnumSchema[]) => MarkdownDocument;

method visitInitializer

visitInitializer: (init: InitializerSchema) => MarkdownDocument;

method visitInstanceMethod

visitInstanceMethod: (method: MethodSchema) => MarkdownDocument;

method visitInstanceMethods

visitInstanceMethods: (methods: MethodSchema[]) => MarkdownDocument;

method visitInterface

visitInterface: (iface: InterfaceSchema) => MarkdownDocument;

method visitInterfaces

visitInterfaces: (ifaces: InterfaceSchema[]) => MarkdownDocument;

method visitParameter

visitParameter: (parameter: ParameterSchema) => MarkdownDocument;

method visitProperties

visitProperties: (properties: PropertySchema[]) => MarkdownDocument;

method visitProperty

visitProperty: (prop: PropertySchema) => MarkdownDocument;

method visitStaticFunction

visitStaticFunction: (method: MethodSchema) => MarkdownDocument;

method visitStaticFunctions

visitStaticFunctions: (methods: MethodSchema[]) => MarkdownDocument;

method visitStruct

visitStruct: (struct: StructSchema) => MarkdownDocument;

method visitStructs

visitStructs: (structs: StructSchema[]) => MarkdownDocument;

method visitSubmodules

visitSubmodules: (
    submodules: readonly reflect.Submodule[],
    fileSuffix: string
) => MarkdownDocument;

property name

readonly name: string;

property name

readonly name: string;

• The name of this error.

property npmErrorCode

readonly npmErrorCode: string;

• The error code npm printed out to stderr or stdout before exiting. This can provide more information about the error in a machine-friendlier way.

  This is extracted from log-parsing, and is hence not guaranteed to be accurate.

  Example 1

  'EPROTO'

  Example 2

  'E429'

  Example 3

  'E404'

property stdout

readonly stdout: {};

• Data the command produced to STDOUT.

constructor

constructor(lang: string, supported: Language[]);

property classes

readonly classes: ClassSchema[];

• Classes.

property constructs

readonly constructs: ConstructSchema[];

• Constructs.

property enums

readonly enums: EnumSchema[];

• Enums.

property interfaces

readonly interfaces: InterfaceSchema[];

• Interfaces.

property structs

readonly structs: StructSchema[];

• Structs.

property packageName

readonly packageName: string;

• Name of the jsii assembly/package.

property packageVersion

readonly packageVersion: string;

• Version of the jsii assembly/package.

property submodule

readonly submodule?: string;

• Language-independent name of the jsii submodule. if undefined, it is implicitly the root module.

  Example 1

  aws_sqs

property displayName

readonly displayName: string;

• The friendly language-specific name for the callable.

property fqn

readonly fqn: string;

• The language-specific fqn.

property id

readonly id: string;

• An id that uniquely identifies this callable among all entities in the document and is same across languages.

property parameters

readonly parameters: ParameterSchema[];

• Parameters of the callable.

property constants

readonly constants: PropertySchema[];

• Constants.

property displayName

readonly displayName: string;

• The friendly language-specific name for the class.

property fqn

readonly fqn: string;

• The language-specific fqn.

property id

readonly id: string;

• An id that uniquely identifies this class among all entities in the document and is same across languages.

property initializer

readonly initializer?: InitializerSchema;

• Class initializer.

property instanceMethods

readonly instanceMethods: MethodSchema[];

• Instance methods.

property interfaces

readonly interfaces: JsiiEntity[];

• Interfaces this class implements.

property properties

readonly properties: PropertySchema[];

• Properties.

property staticMethods

readonly staticMethods: MethodSchema[];

• Static methods.

property deprecated

readonly deprecated?: boolean;

• Whether or not it is deprecated.

property deprecationReason

readonly deprecationReason?: string;

• Deprecation reason (if applicable).

property example

readonly example?: string;

• Code snippet showing example usage of an API item, that has been provided by the construct library authors.

property links

readonly links?: string[];

• @see and @link links with more information.

property remarks

readonly remarks?: string;

• Detailed information about an API item.

  Either the explicitly tagged @remarks section, otherwise everything past the first paragraph if there is no @remarks tag.

property summary

readonly summary?: string;

• Summary documentation for an API item.

  The first part of the documentation before hitting a @remarks tags, or the first line of the doc comment block if there is no @remarks tag.

property docs

readonly docs: DocsSchema;

• Doc string.

property displayName

readonly displayName: string;

• The friendly language-specific name for the enum member.

property fqn

readonly fqn: string;

• The language-specific fqn.

property id

readonly id: string;

• An id that uniquely identifies this enum member among all entities in the document and is same across languages.

property displayName

readonly displayName: string;

• The friendly language-specific name for the enum.

property fqn

readonly fqn: string;

• The language-specific fqn.

property id

readonly id: string;

• An id that uniquely identifies this enum among all entities in the document and is same across languages.

property members

readonly members: EnumMemberSchema[];

• Enum members.

property displayName

readonly displayName: string;

• The friendly language-specific name for the interface.

property fqn

readonly fqn: string;

• The language-specific fqn.

property id

readonly id: string;

• An id that uniquely identifies this interface among all entities in the document and is same across languages.

property implementations

readonly implementations: JsiiEntity[];

• Types implementing this interface.

property instanceMethods

readonly instanceMethods: MethodSchema[];

• Methods.

property interfaces

readonly interfaces: JsiiEntity[];

• Interfaces that this interface extends.

property properties

readonly properties: PropertySchema[];

• Properties.

property displayName

readonly displayName: string;

• The friendly language-specific name for the entity.

property fqn

readonly fqn: string;

• The language-specific type FQN.

property id

readonly id: string;

• An id that uniquely identifies this type among all entities in the document and is same across languages.

property anchorFormatter

readonly anchorFormatter?: (type: JsiiEntity) => string;

• How jsii entity IDs should be formatted into anchors. This should be customized in conjunction with linkFormatter.

  Parameter type

  the entity we are creating an anchor for

  - use the full id

  Modifiers

  • @experimental

property header

readonly header?: {
    title: string;
    id: string;
};

property linkFormatter

readonly linkFormatter?: (
    type: JsiiEntity,
    metadata: AssemblyMetadataSchema
) => string;

• How should links to entities be rendered. For example, if a class or a property is referenced within a description or table.

  The metadata parameter can be optionally used to customize links based on whether or not the type belongs to the package / submodule that is being generated.

  Parameter type

  the entity we are creating a link for

  Parameter metadata

  information about the module being docgen-ed

  - '{type.displayName}' if the type belongs to this package, '{type.fqn}' otherwise

  Modifiers

  • @experimental

property typeFormatter

readonly typeFormatter?: (
    type: TypeSchema,
    metadata: AssemblyMetadataSchema,
    linkFormatter: (type: JsiiEntity, metadata: AssemblyMetadataSchema) => string
) => string;

• How type signatures should be formatted, including those made of nested types (like Map<string, Bucket>).

  The metadata and linkFormatter parameters are provided so that links can be included in the formatted types if desired.

  Parameter type

  the type being formatted

  Parameter metadata

  information about the module being docgen-ed

  Parameter linkFormatter

  the type link formatter

  - HTML code block with type references linked according to linkFormatter

  Modifiers

  • @experimental

property language

readonly language: Language;

• Language the documentation is rendered for.

property default

readonly default?: string;

• The default value, if applicable. - none

property optional

readonly optional?: boolean;

• Whether or not it is optional. false

property displayName

readonly displayName: string;

• The friendly language-specific name for the parameter.

property fqn

readonly fqn: string;

• The language-specific fqn.

property id

readonly id: string;

• An id that uniquely identifies this parameter among all entities in the document and is same across languages.

property type

readonly type: TypeSchema;

• The type of the parameter.

property variadic

readonly variadic: boolean;

• Whether the parameter is variadic.

property const

readonly const?: boolean;

• Whether the property is a constant. false

property displayName

readonly displayName: string;

• The friendly language-specific name for the property.

property fqn

readonly fqn: string;

• The language-specific fqn.

property id

readonly id: string;

• An id that uniquely identifies this property among all entities in the document and is same across languages.

property type

readonly type: TypeSchema;

• The type of the property.

property allSubmodules

readonly allSubmodules?: boolean;

• Whether this document represents documentation for all submodules (including the root).

  false

property apiReference

readonly apiReference?: ApiReferenceSchema;

• API Reference.

property language

readonly language: string;

• Language that the documentation has been transliterated to.

property metadata

readonly metadata: AssemblyMetadataSchema;

• Assembly metadata.

property readme

readonly readme?: string;

• Readme.

property version

readonly version: string;

• Schema version number.

property displayName

readonly displayName: string;

• The friendly language-specific name for the struct.

property fqn

readonly fqn: string;

• The language-specific fqn.

property id

readonly id: string;

• An id that uniquely identifies this struct among all entities in the document and is same across languages.

property properties

readonly properties: PropertySchema[];

• Properties.

property formattingPattern

readonly formattingPattern: string;

• The language-specific name of the type. May contain "%" placeholder values to indicate references to types defined in the "types" field.

  Example 1

  "string"

  Example 2

  "%"

  Example 3

  "typing.List[%]"

  Example 4

  "Map<%, %>"

property types

readonly types?: (TypeSchema | JsiiEntity)[];

• Types referenced within the "name" field. The order of these corresponds to the order of the %'s in formattingPattern.

property usage

readonly usage?: string;

• Code snippet. - none