Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SchemaDefRequirement

Auto-generated class implementation for https://w3id.org/cwl/cwl#SchemaDefRequirement

This field consists of an array of type definitions which must be used when interpreting the inputs and outputs fields. When a type field contains a IRI, the implementation must check if the type is defined in schemaDefs and use that definition. If the type is not found in schemaDefs, it is an error. The entries in schemaDefs must be processed in the order listed such that later schema definitions may refer to earlier schema definitions.

  • Type definitions are allowed for enum and record types only.
  • Type definitions may be shared by defining them in a file and then $include-ing them in the types field.
  • A file can contain a list of type definitions

Hierarchy

  • Saveable
    • SchemaDefRequirement

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

class_

class_: SCHEMADEFREQUIREMENT

Always 'SchemaDefRequirement'

Optional extensionFields

extensionFields?: Dictionary<any>

loadingOptions

loadingOptions: LoadingOptions

types

types: (CommandInputRecordSchema | CommandInputEnumSchema | CommandInputArraySchema)[]

The list of type definitions.

Static attr

attr: Set<string> = ...

Methods

save

  • save(top?: boolean, baseUrl?: string, relativeUris?: boolean): Dictionary<any>

  • Parameters

    • top: boolean = false
    • baseUrl: string = ''
    • relativeUris: boolean = true

    Returns Dictionary<any>

Static fromDoc

  • fromDoc(__doc: any, baseuri: string, loadingOptions: LoadingOptions, docRoot?: string): Promise<Saveable>

  • Used to construct instances of .

    throws

    ValidationException If the document fragment is not a {@link Dictionary} or validation of fields fails.

    Parameters

    • __doc: any

      Document fragment to load this record object from.

    • baseuri: string

      Base URI to generate child document IDs against.

    • loadingOptions: LoadingOptions

      Context for loading URIs and populating objects.

    • Optional docRoot: string

      ID at this position in the document (if available)

    Returns Promise<Saveable>

    An instance of

Generated using TypeDoc