Class ChunkMetadata

constructor

• new ChunkMetadata(options?: ChunkMetadataOptions): ChunkMetadata

  Parameters

  • options: ChunkMetadataOptions = {}

  Returns ChunkMetadata

attributes

mimetype

timestamp

approxBytes

• get approxBytes(): number

  Approximate encoded field size.

  Returns number

getAttribute

• getAttribute(key: string): StatusOr<Uint8Array<ArrayBufferLike>>

  Return a copy of one attribute.

  Parameters

  • key: string

  Returns StatusOr<Uint8Array<ArrayBufferLike>>

setAttribute

• setAttribute(key: string, value: Uint8Array): Status

  Set one attribute after validating its name.

  Parameters

  • key: string
  • value: Uint8Array

  Returns Status

toMsgpack

• toMsgpack(): StatusOr<Uint8Array<ArrayBufferLike>>

  Encode the concatenated MessagePack metadata record.

  Returns StatusOr<Uint8Array<ArrayBufferLike>>

validate

• validate(): Status

  Validate MIME, timestamp, and attribute fields.

  Returns Status

Staticcreate

• create(
      options?: Omit<ChunkMetadataOptions, "attributes"> & {
          attributes?: ByteMapInput;
      },
  ): StatusOr<ChunkMetadata>

  Construct and validate metadata while normalizing byte-like attributes.

  Parameters

  • options: Omit<ChunkMetadataOptions, "attributes"> & { attributes?: ByteMapInput } = {}

  Returns StatusOr<ChunkMetadata>

StaticfromMsgpack

• fromMsgpack(bytes: Uint8Array): StatusOr<ChunkMetadata>

  Decode a concatenated MessagePack metadata record.

  Parameters

  • bytes: Uint8Array

  Returns StatusOr<ChunkMetadata>