Join

Optional join of another collection onto each search result. Forms: \'\', \'[=]\', or with \'()\'. Parent refs: $id, $.meta.. Child refs: $$id, $$.meta.. Omitted \'[]\' defaults to [$id=$$id]. Joined documents appear under joined[collection_name].

Properties

Name	Type

Example

import type { Join } from ''

// TODO: Update the object below with actual values
const example = {
} satisfies Join

console.log(example)

// Convert the instance to a JSON string
const exampleJSON: string = JSON.stringify(example)
console.log(exampleJSON)

// Parse the JSON string back to an object
const exampleParsed = JSON.parse(exampleJSON) as Join
console.log(exampleParsed)

[Back to top] [Back to API list] [Back to Model list] [Back to README]