@yorkie-js/sdk
    Preparing search index...

    Function parse

    • parse parses a YSON string into a typed JavaScript object.

      YSON extends JSON to support Yorkie CRDT types:

      • Text([...]) for Text CRDT
      • Tree(...) for Tree CRDT
      • Standard JSON for primitives, objects, and arrays

      Type Parameters

      Parameters

      • yson: string

        YSON formatted string

      Returns T

      Parsed YSONValue

      YorkieError if parsing fails

      const data = parse('{"content":Text([{"val":"Hi"}])}');
      // { content: { type: 'Text', nodes: [{ val: 'Hi' }] } }

      // With type parameter:
      const data = parse<{ content: YSONText }>('{"content":Text([{"val":"Hi"}])}');
      // data.content is now typed as YSONText