Function createFlake

Builds a Flake from a Shape and an optional Model or Query.

createFlake(shape: Lazy<Shape>): Flake
Builds a flake from a shape, capturing its full structural reach.

A non-resource root yields a degenerate leaf flake with no property branches.
Parameters
- shape: Lazy<Shape>
  The lazy root shape
Returns Flake
An immutable Flake over the shape structural reach
- Defined in index.ts:268
createFlake(shape: Lazy<Shape>, model: Model): Flake
Builds a flake from a shape and a retrieval model, keeping only the properties the model addresses, each branch carrying the drain requested for it.

Property branches form only for a @metreeca/qest/template!Template model on a resource root; any other Model form, or a non-resource root, yields a degenerate leaf flake.
Parameters
- shape: Lazy<Shape>
  The lazy root shape
- model: Model
  The retrieval Model selecting the properties to keep
Returns Flake
An immutable Flake restricted to the model-addressed properties
- Defined in index.ts:282
createFlake(shape: Lazy<Shape>, query: Query): Flake
Builds a flake from a collection member shape and a query, tagging each addressed node with the constraints, ordering, and projection the query expresses.
Parameters
- shape: Lazy<Shape>
  The lazy member shape of the collection elements
- query: Query
  The collection Query to apply
Returns Flake
An immutable Flake tagged with the query constraints, ordering, and projection
- Defined in index.ts:293