@ts4ocds/requirements/requirement/string-requirement.d.ts

TS4OCDS is a library of TypeScript entities that takes an approach to befriend large OCDS JSONs with your per-project routine of writing whole lotta interfaces for them.

/**
 * @packageDocumentation
 * @module Requirements.Requirement
 */

import type { Requirement } from './requirement';

/**
 * An atomic requirement.
 * Requirements can specify the expected value that the {@link RequirementResponse.RequirementResponse | response} has to contain,
 * or a {@link RangedRequirement | range} of threshold values within which the {@link RequirementResponse.RequirementResponse | response} has to fit in.
 * The requirement may apply to a certain {@link Period.Period | period} of time.
 */
export interface StringRequirement extends Requirement {
  /**
   * The {@link DataType | data type} in which the {@link RequirementResponse.RequirementResponse | requirement response} must be provided.
   */
  dataType: 'string';

  /**
   * Used to state the requirement when the {@link RequirementResponse.RequirementResponse | response} must be particular `string` value.
   */
  expectedValue?: string;

  /**
   * A regular expression against which to validate the {@link RequirementResponse.RequirementResponse | requirement response}.
   */
  pattern?: string;
}