Function parseTimespan

parseTimespan<TOptions>(timespan: {
    base?: string;
    end?: string;
    field?: MetadataFieldValueType[];
    group?: MetadataGroupValueType[];
    start?: string;
}, options?: TOptions): ParsedTimespan<TOptions>
Parses timespan according to specified options

Remarks
To ensure a flat (no array) representation when using flat: true, the parser will also set overrideGroup and overrideField to true (unless those are explicitly set false)

Returns
Timespan parsed according to options

See
parseGroupList and parseFieldList for more info
Type Parameters
- TOptions extends ParseTimespanOptions = ParseTimespanOptions
Parameters
- timespan: {
      base?: string;
      end?: string;
      field?: MetadataFieldValueType[];
      group?: MetadataGroupValueType[];
      start?: string;
  }
  
  A VidiCore metadata timespan
  - Optional base?: string
  - Optional end?: string
  - Optional field?: MetadataFieldValueType[]
  - Optional group?: MetadataGroupValueType[]
  - Optional start?: string
- Optional options: TOptions
  
  Options to change how it is parsed
Returns ParsedTimespan<TOptions>