Function setScalarValue

setScalarValue(token, value, context?): void
Set the value of token to the given string value, overwriting any previous contents and type that it may have.

Best efforts are made to retain any comments previously associated with the token, though all contents within a collection's items will be overwritten.

Values that represent an actual string but may be parsed as a different type should use a type other than 'PLAIN', as this function does not support any schema operations and won't check for such conflicts.
Parameters
- token: yaml.CST.Token
  Any token. If it does not include an indent value, the value will be stringified as if it were an implicit key.
- value: string
  The string representation of the value, which will have its content properly indented.
- Optional context: {
      afterKey?: boolean;
      implicitKey?: boolean;
      inFlow?: boolean;
      type?: Type;
  }
  - Optional afterKey?: boolean
    In most cases, values after a key should have an additional level of indentation.
  - Optional implicitKey?: boolean
    Being within an implicit key may affect the resolved type of the token's value.
  - Optional inFlow?: boolean
    Being within a flow collection may affect the resolved type of the token's value.
  - Optional type?: Type
    The preferred type of the scalar token. If undefined, the previous type of the token will be used, defaulting to 'PLAIN'.
Returns void
- Defined in node_modules/yaml/dist/parse/cst-scalar.d.ts:59

Generated using TypeDoc