Cachex v3.6.0

View Source Cachex.Spec.Validator (Cachex v3.6.0)

Validation module for records defined in the specification.

This module just exposes runtime validation functions for records defined in the spec; records themselves only determine keys and structure but cannot enforce type (that I know of) without additional runtime validations.

This shouldn't be used outside of the library, but it can be if required.

Link to this section Summary

Types

record()

Functions

valid?(arg1, limit)

Validates a specification record type.

Link to this section Types

Link to this type

record()

View Source 
@type record() ::
  Cachex.Spec.command()
  | Cachex.Spec.entry()
  | Cachex.Spec.expiration()
  | Cachex.Spec.fallback()
  | Cachex.Spec.hook()
  | Cachex.Spec.hooks()
  | Cachex.Spec.limit()
  | Cachex.Spec.warmer()

Link to this section Functions

Link to this function

valid?(arg1, limit)

View Source 
@spec valid?(atom(), record()) :: boolean()

Validates a specification record type.

This will provide runtime validation of types and values contained inside the specification records. Although records provide key validation, they don't expose much coverage of the provided values.

This will delegate each record type to a customized validation function.