Options
All
  • Public
  • Public/Protected
  • All
Menu

Represents a Package.

Hierarchy

  • Package

Implements

Index

Constructors

constructor

  • Constructs a new Package.

    Parameters

    Returns Package

Properties

author

author: string

Package author.

bugTrackerURL

bugTrackerURL: string

Package bugTrackerURL.

dependencies

dependencies: IPackage[]

Package dependencies.

description

description: string

Package description.

documentationURL

documentationURL: string

Package documentationURL.

homepageURL

homepageURL: string

Package homepageURL.

license

license: string

Package license.

name

name: string

Package name.

sourceCodeURL

sourceCodeURL: string

Package sourceCodeURL.

spec

spec: string

Package spec.

version

version: string

Package version.

Methods

toJSON

  • toJSON(): object
  • Converts this Package to JSON.

    Returns object

    JSON object

    • [k: string]: any

Static create

  • Creates a new Package instance using the specified properties.

    Parameters

    Returns Package

    Package instance

Static decode

  • decode(reader: Reader | Uint8Array, length?: undefined | number): Package
  • Decodes a Package message from the specified reader or buffer.

    throws

    {Error} If the payload is not a reader or valid buffer

    throws

    {$protobuf.util.ProtocolError} If required fields are missing

    Parameters

    • reader: Reader | Uint8Array

      Reader or buffer to decode from

    • Optional length: undefined | number

    Returns Package

    Package

Static decodeDelimited

  • decodeDelimited(reader: Reader | Uint8Array): Package
  • Decodes a Package message from the specified reader or buffer, length delimited.

    throws

    {Error} If the payload is not a reader or valid buffer

    throws

    {$protobuf.util.ProtocolError} If required fields are missing

    Parameters

    • reader: Reader | Uint8Array

      Reader or buffer to decode from

    Returns Package

    Package

Static encode

  • encode(message: IPackage, writer?: $protobuf.Writer): Writer
  • Encodes the specified Package message. Does not implicitly verify messages.

    Parameters

    • message: IPackage

      Package message or plain object to encode

    • Optional writer: $protobuf.Writer

    Returns Writer

    Writer

Static encodeDelimited

  • encodeDelimited(message: IPackage, writer?: $protobuf.Writer): Writer
  • Encodes the specified Package message, length delimited. Does not implicitly verify messages.

    Parameters

    • message: IPackage

      Package message or plain object to encode

    • Optional writer: $protobuf.Writer

    Returns Writer

    Writer

Static fromObject

  • fromObject(object: object): Package
  • Creates a Package message from a plain object. Also converts values to their respective internal types.

    Parameters

    • object: object

      Plain object

      • [k: string]: any

    Returns Package

    Package

Static toObject

  • toObject(message: Package, options?: $protobuf.IConversionOptions): object
  • Creates a plain object from a Package message. Also converts values to other types if specified.

    Parameters

    • message: Package

      Package

    • Optional options: $protobuf.IConversionOptions

    Returns object

    Plain object

    • [k: string]: any

Static verify

  • verify(message: object): null | string
  • Verifies a Package message.

    Parameters

    • message: object

      Plain object to verify

      • [k: string]: any

    Returns null | string

    null if valid, otherwise the reason why it is not

Generated using TypeDoc