Skip to content

shorthand

Get the full shorthand of a reference.

This will transform the reference name into a name "human-readable" version. If no shortname is appropriate, it will return the full name.

Signature

ts
class Reference {
  shorthand(): string;
}

Returns

  • string

    Full shorthand of a reference.

Errors

  • Error

    Throws error if the shorthand is not valid utf-8.

Released under the MIT License.