gflare - v1.2.3

gflare/validate

Types

Schema

</> 
pub type Schema(a) {
  Schema(
    decode: fn(dynamic.Dynamic) -> Result(
      a,
      List(ValidationError),
    ),
    field_name: String,
  )
}

Constructors

ValidationError

</> 
pub type ValidationError {
  ValidationError(field: String, message: String)
}

Constructors 

  • ValidationError(field: String, message: String)

Values

between

</> 
pub fn between(
  schema: Schema(Int),
  min_val: Int,
  max_val: Int,
) -> Schema(Int)

bool

</> 
pub fn bool(field: String) -> Schema(Bool)

custom

</> 
pub fn custom(
  schema: Schema(a),
  validator: fn(a) -> Result(a, String),
) -> Schema(a)

date

</> 
pub fn date(field: String) -> Schema(String)

datetime

</> 
pub fn datetime(field: String) -> Schema(String)

email

</> 
pub fn email(field: String) -> Schema(String)

errors_to_string

</> 
pub fn errors_to_string(errors: List(ValidationError)) -> String

float

</> 
pub fn float(field: String) -> Schema(Float)

format_errors

</> 
pub fn format_errors(errors: List(ValidationError)) -> json.Json

Format validation errors as JSON for API responses.

int

</> 
pub fn int(field: String) -> Schema(Int)

Create an integer schema for the given field.

max

</> 
pub fn max(schema: Schema(Int), max_val: Int) -> Schema(Int)

max_length

</> 
pub fn max_length(
  schema: Schema(String),
  length: Int,
) -> Schema(String)

min

</> 
pub fn min(schema: Schema(Int), min_val: Int) -> Schema(Int)

min_length

</> 
pub fn min_length(
  schema: Schema(String),
  length: Int,
) -> Schema(String)

negative

</> 
pub fn negative(schema: Schema(Int)) -> Schema(Int)

one_of

</> 
pub fn one_of(
  field: String,
  values: List(String),
) -> Schema(String)

optional

</> 
pub fn optional(
  field: String,
  schema: Schema(a),
) -> Schema(option.Option(a))

pattern

</> 
pub fn pattern(
  schema: Schema(String),
  pattern_str: String,
) -> Schema(String)

positive

</> 
pub fn positive(schema: Schema(Int)) -> Schema(Int)

required

</> 
pub fn required(field: String, schema: Schema(a)) -> Schema(a)

string

</> 
pub fn string(field: String) -> Schema(String)

Create a string schema for the given field.

time

</> 
pub fn time(field: String) -> Schema(String)

ulid

</> 
pub fn ulid(field: String) -> Schema(String)

url

</> 
pub fn url(field: String) -> Schema(String)

uuid

</> 
pub fn uuid(field: String) -> Schema(String)

validate

</> 
pub fn validate(
  schema: Schema(a),
  data: dynamic.Dynamic,
) -> Result(a, List(ValidationError))

Validate data against a schema. Returns Ok(value) or Error(list of validation errors).

validate_body

</> 
pub fn validate_body(
  schema: Schema(a),
  request: request.HttpRequest,
) -> promise.Promise(Result(a, List(ValidationError)))

Validate request body against a schema. Returns Ok(value) or Error(list of validation errors).

✨ Search Document