Class Hash

Specifies the file hash of the component

Generated

from message cyclonedx.v1_6.Hash

Hierarchy

Constructors

constructor

Properties

alg value fields runtime typeName

Methods

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

Constructors

constructor

Properties

alg

alg: cdx_16.HashAlg = HashAlg.NULL

Specifies the algorithm used to create the hash

Generated

from field: cyclonedx.v1_6.HashAlg alg = 1;

value

value: string = ""

SimpleContent value of element

Generated

from field: string value = 2;

Static Readonly fields

fields: FieldList = ...

Static Readonly runtime

runtime: ProtoRuntime = proto3

Static Readonly typeName

typeName: "cyclonedx.v1_6.Hash" = "cyclonedx.v1_6.Hash"

Methods

clone

  • clone(): cdx_16.Hash

  • Create a deep copy.

    Returns cdx_16.Hash

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_16.Hash>

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

    Returns MessageType<cdx_16.Hash>

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

constructoralgvaluefieldsruntimetypeNamecloneequalsfromBinaryfromJsonfromJsonStringgetTypetoBinarytoJSONtoJsontoJsonStringequalsfromBinaryfromJsonfromJsonString