parseInclude

Function

Parse an IncludeSpec from the include string Include String structure:

  • enrichment{.deep.path} AS propertyName

Examples

  • server.layers.0.name as layerName -> use the server enrichment, extract the name of the first layer and attach that as layerName
  • server.layers -> use the server enrichment, attach the layers array as layers
  • parseInclude(include: string) : IIncludeSpec

Parameters

Parameter Type Default Notes
include Required string

Returns

IIncludeSpec
Property Type Notes

Function defined in common/src/search/_internal/parseInclude.ts:34