Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Metadata

Hierarchy

  • Metadata

Implemented by

Index

Properties

Methods

Properties

Optional date

date: undefined | string

The date at which the file was generated.

Optional generator

generator: undefined | string

The name of the software that generated the JSON metadata used by this object.

version

version: string

Records the version number of the format of the metadata file.

Methods

documentationLinkFor

  • documentationLinkFor(name: EName): string | undefined

  • Returns a URL to the documentation for an element. The element should be named according to the mappings reported by the resolve returned by "wed/mode".Mode.getAbsoluteResolver.

    Parameters

    • name: EName

      The name of the element.

    Returns string | undefined

    The URL. If the value returned is undefined, then the URL is not available.

getNamespaceMappings

  • getNamespaceMappings(): Record<string, string>

  • Returns absolute namespace mappings.

    Returns Record<string, string>

    An object whose keys are namespace prefixes and values are namespace URIs. The object returned by this method should not be modified.

isInline

  • isInline(node: Element): boolean

  • This method determines whether a node needs to be represented inline.

    Parameters

    • node: Element

      The node to examine.

    Returns boolean

    True if the node should be inline, false otherwise.

shortDescriptionFor

  • shortDescriptionFor(name: EName): string | undefined

  • Returns a short description for an element. The element should be named according to the mappings reported by getNamespaceMappings.

    Parameters

    • name: EName

      The name of the element.

    Returns string | undefined

    The description. If the value returned is undefined, then the description is not available.

unresolveName

  • unresolveName(name: EName): string | undefined

  • Unresolve a name using the mapping defined by the metadata.

    Parameters

    • name: EName

      The name to unresolve.

    Returns string | undefined

    The unresolved name or undefined if the name cannot be unresolved.

Generated using TypeDoc