Header menu logo Falco.UnionRoutes

Extraction Module

Core types and functions for extracting values from HTTP requests.

This module provides the building blocks for type-safe route extraction:

  • Parser<'T> - converts strings to typed values (for route/query params)
  • Extractor<'T,'E> - extracts values from HTTP context (for auth, headers, etc.)
  • Extractor.parser - registers a parser for custom types
  • Extractor.precondition - registers extractors for both PreCondition and OverridablePreCondition fields

Types and nested modules

Type/Module Description

Extractor

Factory functions for creating extractors to use with EndpointConfig.

EndpointConfig<'E>

Configuration for Route.endpoints - bundles all extraction settings.

Extractor<'T, 'E>

Asynchronously extracts a value from HTTP context. Used for authentication, authorization, reading headers, cookies, database lookups, or any value that requires request context.

FieldParser

Registers a parser for a custom type in route/query parameters.

Parser<'T>

Converts a string to a typed value. Used for route and query parameters.

PreconditionExtractor<'E>

Registers an extractor for PreCondition or OverridablePreCondition fields.

SyncExtractor<'T, 'E>

Synchronous extractor — convenience alias for extractors that don't need async. Wrap with Task.FromResult or use Extractor.preconditionSync to convert.

Type something to start searching.