Class GluonCacheRule<T>

constructor

• new GluonCacheRule<T>(): GluonCacheRule<T>

  Type Parameters

  • T

  Returns GluonCacheRule<T>

OptionalhandlerFunction

Optionalname

OptionalretrieveFunction

OptionalstructureType

applyRule

• applyRule(): void

  Apply the rule to the structure type.

  Returns void

  Method

  Throws

setHandlerFunction

• setHandlerFunction(
      handlerFunction: GluonCacheRuleHandlerFunction<T>,
  ): GluonCacheRule<T>

  Set the function which handles the rule. The function is passed the structure data that this rule is for.

  Parameters

  • handlerFunction: GluonCacheRuleHandlerFunction<T>

    A function that handles the rule.

  Returns GluonCacheRule<T>

  Method

  Throws

setName

• setName(name: string): GluonCacheRule<T>

  The name of the rule.

  Parameters

  • name: string

    What the rule is called.

  Returns GluonCacheRule<T>

setRetrieveFunction

• setRetrieveFunction(
      retrieveFunction: GluonCacheRuleRetrieveFunction<T>,
  ): GluonCacheRule<T>

  Set the function which retrieves the data for the structure.

  Parameters

  • retrieveFunction: GluonCacheRuleRetrieveFunction<T>

    The function that retrieves the data for the structure.

  Returns GluonCacheRule<T>

  Method

  Throws

setStructureType

• setStructureType(structureType: StaticManagerType<T>): GluonCacheRule<T>

  Set the type of structure this rule is for. Pass the class of the structure type.

  Parameters

  • structureType: StaticManagerType<T>

    The type of structure this rule is for.

  Returns GluonCacheRule<T>

  Method

  Throws