MatchingResource <S>

A resource found by schema. See MatchingAnchor.

Pass one wherever a resource parent is expected, and the translation is carried into the graph, so the child keeps reading its parent through the schema it was written against.

@group

Types

Index

Constructors

• constructor

Properties

• schemaTranslator

Methods

• getActual
• getSchemaInstance
• getSchemaInstanceInResourceAction
• hasSchemaTranslator

Constructors

constructor

• MatchingResource<S>(actual: AResource<S, any>, schemaTranslator?: (synth: BaseResourceSchema) => S): MatchingResource<S>

• Type parameters

  • S: BaseResourceSchema

  Parameters

  • actual: AResource<S, any>

    The resource that was matched.

  • optionalschemaTranslator: (synth: BaseResourceSchema) => S

    Reads actual as the matched schema, when the two differ.

  Returns MatchingResource<S>

Properties

optionalreadonlyschemaTranslator

schemaTranslator?: (synth: BaseResourceSchema) => S

Reads actual as the matched schema, when the two differ.

---

Type declaration

• • (synth: BaseResourceSchema): S

  • Parameters

    • synth: BaseResourceSchema

    Returns S

Methods

getActual

• getActual(): AResource<Omit<S, properties | response | tags> & { properties: Record<never, never> } & { response: Record<never, never> } & { tags: Record<never, never> }, any>

• The resource itself, with its schema hidden - read it through MatchingResource.getSchemaInstance.

  ---

  Returns AResource<Omit<S, properties | response | tags> & { properties: Record<never, never> } & { response: Record<never, never> } & { tags: Record<never, never> }, any>

getSchemaInstance

• getSchemaInstance(): S

• The resource read as the schema you matched on.

  ---

  Returns S

getSchemaInstanceInResourceAction

• getSchemaInstanceInResourceAction(): Omit<S, response> & { response: Required<S[response]> }

• The resource read as the schema you matched on, with its response typed as fully populated. Only call it from a resource action, where the parent is guaranteed to already exist.

  ---

  Returns Omit<S, response> & { response: Required<S[response]> }

hasSchemaTranslator

• hasSchemaTranslator(): boolean

• Whether the match went through a schema translation.

  ---

  Returns boolean