Class _projectMetadata

external

path

jsonReady

• get jsonReady(): this

• Returns this

schema

• get schema(): JSONSchema3or4

• Returns JSONSchema3or4

assign

• assign(metadata: Record<string, any>): any

• The function assigns metadata to an object and returns the updated object.

  Parameters

  • metadata: Record<string, any>

    The metadata parameter is an object that contains key-value pairs. The keys are strings, and the values can be of any type.

  Returns any

  the object that the method is being called on (i.e., this).

complete

• complete(metadata: Record<string, any>): any

• The function takes in a metadata object, ensures its structure, flattens it, merges it with the existing metadata of the object, and returns the updated metadata object.

  Parameters

  • metadata: Record<string, any>

    The metadata parameter is an object that contains key-value pairs representing metadata information. The keys are strings, and the values can be of any type.

  Returns any

  the metadata object with any missing keys from the original object added.

ensureMetadata

• ensureMetadata(metadata: Record<string, any>): {}

• The ensureMetadata function takes in a metadata object, flattens the current object and the metadata object, merges them together, and then returns the merged object in its original nested structure.

  Parameters

  • metadata: Record<string, any>

    The metadata parameter is a record object that contains key-value pairs. The keys represent the metadata properties, and the values represent the corresponding values for those properties.

  Returns {}

  The function ensureMetadata returns the metadata object with any missing values filled in with the corresponding values from the original object.

flat

• flat(): Record<string, any>

• Returns Record<string, any>

isValidMetadata

• isValidMetadata(metadata: Record<string, any>): boolean

• The function checks if all the keys in the object are present in the metadata object.

  Parameters

  • metadata: Record<string, any>

    The metadata parameter is a record object that contains key-value pairs. The keys are strings and the values can be of any type.

  Returns boolean

  a boolean value.

validate

• validate(metadata: any): metadata is unknown

• Parameters

  • metadata: any

  Returns metadata is unknown

StaticensureMetadata

• ensureMetadata<T>(
      metaConstructor:
          | typeof _meta
          | typeof _orderMetadata
          | typeof _deliverableMetadata
          | typeof _workMetadata
          | typeof _materialMetadata
          | typeof _requirementMetadata
          | typeof _testMetadata
          | typeof _fileMetadata,
      metadata: Record<string, any>,
  ): T

• Type Parameters

  • T

  Parameters

  • metaConstructor:
        | typeof _meta
        | typeof _orderMetadata
        | typeof _deliverableMetadata
        | typeof _workMetadata
        | typeof _materialMetadata
        | typeof _requirementMetadata
        | typeof _testMetadata
        | typeof _fileMetadata
  • metadata: Record<string, any>

  Returns T

StaticfilterObjectBySchema

• filterObjectBySchema(source: any, schema: any): {}

• Parameters

  • source: any
  • schema: any

  Returns {}