Function email

email<const C extends StringValueConstraints = {}>(
constraints?: C,
): StringShape<{ inferred from <C> }>
Creates a shape for email address values.

Fixes the datatype to xsd:string.
Type Parameters
- const C extends StringValueConstraints = {}
  The stated constraints
Parameters
- Optionalconstraints: C
  Optional value constraints
Returns StringShape<{ inferred from <C> }>
An immutable shape admitting email addresses, narrowed to the values the constraints enumerate

Throws
TraceError Where the stated constraints contradict one another

See
RFC 5321 - Simple Mail Transfer Protocol
- Defined in src/string/index.ts:508