Class License

Generated

from message cyclonedx.v1_5.License

Hierarchy

Constructors

constructor

Properties

bomRef? license licensing? properties text? url? fields runtime typeName

Methods

clone equals fromBinary fromJson fromJsonString getType toBinary toJSON toJson toJsonString equals fromBinary fromJson fromJsonString

Constructors

constructor

Properties

Optional bomRef

bomRef?: string

An optional identifier which can be used to reference the license elsewhere in the BOM. Uniqueness is enforced within all elements and children of the root-level bom element.

Generated

from field: optional string bom_ref = 5;

license

license: {
    case: "id";
    value: string;
} | {
    case: "name";
    value: string;
} | {
    case: undefined;
    value?: undefined;
} = ...

Type declaration

  • case: "id"
  • value: string

    A valid SPDX license ID

    Generated

    from field: string id = 1;

Type declaration

  • case: "name"
  • value: string

    If SPDX does not define the license used, this field may be used to provide the license name

    Generated

    from field: string name = 2;

Type declaration

  • case: undefined
  • Optional value?: undefined

Generated

from oneof cyclonedx.v1_5.License.license

Optional licensing

licensing?: cdx_15.Licensing

Licensing details describing the licensor/licensee, license type, renewal and expiration dates, and other important metadata

Generated

from field: optional cyclonedx.v1_5.Licensing licensing = 6;

properties

properties: cdx_15.Property[] = []

Specifies optional, custom, properties

Generated

from field: repeated cyclonedx.v1_5.Property properties = 7;

Optional text

text?: cdx_15.AttachedText

Specifies the optional full text of the attachment

Generated

from field: optional cyclonedx.v1_5.AttachedText text = 3;

Optional url

url?: string

The URL to the attachment file. If the attachment is a license or BOM, an externalReference should also be specified for completeness.

Generated

from field: optional string url = 4;

Static Readonly fields

fields: FieldList = ...

Static Readonly runtime

runtime: ProtoRuntime = proto3

Static Readonly typeName

typeName: "cyclonedx.v1_5.License" = "cyclonedx.v1_5.License"

Methods

clone

  • clone(): cdx_15.License

  • Create a deep copy.

    Returns cdx_15.License

equals

  • equals(other): boolean

  • Compare with a message of the same type.

    Parameters

    Returns boolean

fromBinary

  • fromBinary(bytes, options?): this

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting existing keys.

    If a message field is already present, it will be merged with the new data.

    Parameters

    • bytes: Uint8Array
    • Optional options: Partial<BinaryReadOptions>

    Returns this

fromJson

  • fromJson(jsonValue, options?): this

  • Parse a message from a JSON value.

    Parameters

    • jsonValue: JsonValue
    • Optional options: Partial<JsonReadOptions>

    Returns this

fromJsonString

  • fromJsonString(jsonString, options?): this

  • Parse a message from a JSON string.

    Parameters

    • jsonString: string
    • Optional options: Partial<JsonReadOptions>

    Returns this

getType

  • getType(): MessageType<cdx_15.License>

  • Retrieve the MessageType of this message - a singleton that represents the protobuf message declaration and provides metadata for reflection- based operations.

    Returns MessageType<cdx_15.License>

toBinary

  • toBinary(options?): Uint8Array

  • Serialize the message to binary data.

    Parameters

    • Optional options: Partial<BinaryWriteOptions>

    Returns Uint8Array

Protected toJSON

  • toJSON(): JsonValue

  • Override for serialization behavior. This will be invoked when calling JSON.stringify on this message (i.e. JSON.stringify(msg)).

    Note that this will not serialize google.protobuf.Any with a packed message because the protobuf JSON format specifies that it needs to be unpacked, and this is only possible with a type registry to look up the message type. As a result, attempting to serialize a message with this type will throw an Error.

    This method is protected because you should not need to invoke it directly -- instead use JSON.stringify or toJsonString for stringified JSON. Alternatively, if actual JSON is desired, you should use toJson.

    Returns JsonValue

toJson

  • toJson(options?): JsonValue

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • toJsonString(options?): string

  • Serialize the message to a JSON string.

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

constructorbomReflicenselicensingpropertiestexturlfieldsruntimetypeNamecloneequalsfromBinaryfromJsonfromJsonStringgetTypetoBinarytoJSONtoJsontoJsonStringequalsfromBinaryfromJsonfromJsonString