Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RecordField

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

A field of a record.

Hierarchy

  • Saveable
    • RecordField

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Optional doc

doc?: string | string[]

A documentation string for this object, or an array of strings which should be concatenated.

Optional extensionFields

extensionFields?: Dictionary<any>

loadingOptions

loadingOptions: LoadingOptions

name

name: string

The name of the field

type

type: string | RecordSchema | EnumSchema | ArraySchema | (string | RecordSchema | EnumSchema | ArraySchema)[]

The field type

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