Function parse

Turns the input string into an object.

Remarks

With the custom options, the input string can be either

• a JSON string (identical to JSON.parse())
• an EJSON string (identical to bson.EJSON.parse())
• a minified version of either of the above, where some or specified keys are replaced with a shorter identifier
• a compressed version (by lz4js.compress()) of either of the above

Example

type Foo {
  long_key: string
}

parse<Foo>(
  "{\"lk\":\"A Large Object\"}",
  (key, val) => {
    if (key === "lk") {
      return "A Modified Large Object"
    }
    return val
  },
  {
    extended: false,
    unminify: { enable: true, keyMap: { "lk": "long_key" } },
    decompress: false
  },
  (obj: any): obj is Foo => {
    const _obj: Partial<Foo> | null | undefined = obj
    return typeof _obj?.long_key === "string"
  }
)
Copy

Turns the input string into an object.

Remarks

With the custom options, the input string can be either

• a JSON string (identical to JSON.parse())
• an EJSON string (identical to bson.EJSON.parse())
• a minified version of either of the above, where some or specified keys are replaced with a shorter identifier
• a compressed version (by lz4js.compress()) of either of the above

Example

type Foo {
  long_key: string
}

parse<Foo>(
  "{\"lk\":\"A Large Object\"}",
  {
    extended: false,
    unminify: { enable: true, keyMap: { "lk": "long_key" } },
    decompress: false
  },
  (obj: any): obj is Foo => {
    const _obj: Partial<Foo> | null | undefined = obj
    return typeof _obj?.long_key === "string"
  }
)
Copy