(DOCSP-15613): Node.js embedded objects type

[mohammadhunan-dev]

Pull Request Info

Jira

• https://jira.mongodb.org/browse/DOCSP-15613

Staged Changes (Requires MongoDB Corp SSO)

• Node.js SDK > Data Types > Embedded Objects

Review Guidelines

REVIEWING.md

[dacharyc]

LGTM! Although the tip text did lead me to ask if we might want to add another example to this page.

[dacharyc]

I'm kind of fascinated by the idea of recursively referencing an embedded object type as an optional property in its own definition, but am having trouble visualizing a use case for it. I wonder if this might be a good example to add to the page?

[mohammadhunan-dev]

It might look something like:

const AddressSchema = {
  name: "Address",
  embedded: true, // default: false
  properties: {
    street: "string?",
    city: "string?",
    country: "string?",
    postalCode: "string?",
    address: Address?
  },
};

Though that tip is copied over from the existing docs, and is a scenario we probably don't want to actually show in our docs since it's so unique that I can't think of a practical use-case. The tip does show the sheer flexibility of embedded objects though.