Data validation tools.
type 'a validated = ('a, Required.provider_error) Stdlib.resultA type that describes validated metadata.
val required : string -> ('a, Required.provider_error) Stdlib.resultHelper for Yocaml.Required.DATA_READABLE.neutral.
val validate :
(module Required.DATA_PROVIDER) ->
(module Required.DATA_READABLE with type t = 'a) ->
string option ->
'a validatedvalidate (module Provider) (module Readable) opt_str Validates an optional string described in the syntax described by the Provider module using the validation function described by the Readable module. The function uses Readable.neutral as a fallback if the string is null.
A set of functions for extracting metadata from a read document.
Defines the extraction strategy for a set of metadata.
There are several strategies for describing how to separate metadata from the actual content, but it is also possible to provide your own implementation using the Custom constructor.
val regular : char -> extraction_strategyDefine a regular strategy, using 3 char as a delimiter.
val jekyll : extraction_strategyDefine the front-matter delimiter.
val custom : (string -> string option * string) -> extraction_strategyDefine a custom extraction strategy.
val extract_from_content :
strategy:extraction_strategy ->
string ->
string option * stringextract_from_content ~strategy content Attempts to extract metadata from a document using a defined strategy.