MatchingResource <S>

@group

Types

Index

Constructors

• constructor

Properties

• schemaTranslator

Methods

• addChild
• 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>

  • optionalschemaTranslator: (synth: BaseResourceSchema) => S

  Returns MatchingResource<S>

Properties

optionalreadonlyschemaTranslator

schemaTranslator?: (synth: BaseResourceSchema) => S

Type declaration

• • (synth: BaseResourceSchema): S

  • Parameters

    • synth: BaseResourceSchema

    Returns S

Methods

addChild

• addChild(...args: [onField: string | number | symbol, child: UnknownResource, toField: string]): { childToParentDependency: Dependency; parentToChildDependency: Dependency }

• Parameters

  • rest...args: [onField: string | number | symbol, child: UnknownResource, toField: string]

  Returns { childToParentDependency: Dependency; parentToChildDependency: Dependency }

  • childToParentDependency: Dependency

  • parentToChildDependency: Dependency

getActual

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

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

getSchemaInstance

• getSchemaInstance(): S

• Returns S

getSchemaInstanceInResourceAction

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

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

hasSchemaTranslator

• hasSchemaTranslator(): boolean

• Returns boolean