Skip to content

Additional Documentation and Examples #280

Description

@rae-hill

All the schemas and primary modules can generally use some sprucing up to their JsDoc descriptions along with some examples.

Create a new issue by hovering over a list item below which will automatically mark that item as done once a PR closing that issue has been merged.

  • Annotate.ts
  • Array.ts
  • Ascii.ts
  • Base64.ts
  • Base64Url.ts
  • BigIntFromString.ts
  • BitcoinAddress.ts
  • Boolean.ts
  • BooleanFromNumber.ts
  • BooleanFromString.ts
  • Brand.ts
  • CamelCaseKeys.ts
  • CamelCaseRecord.ts
  • CamelCaseString.ts
  • CheckDigit.ts
  • CreditCard.ts
  • Date.ts
  • DateFromInt.ts
  • DateFromIsoString.ts
  • DateFromString.ts
  • DateFromUnixTime.ts
  • EmailAddress.ts
  • EthereumAddress.ts
  • Float.ts
  • FloatFromString.ts
  • HexColor.ts
  • Hexadecimal.ts
  • HslColor.ts
  • Imap.ts
  • Int.ts
  • IntFromString.ts
  • Intersect.ts
  • Jwt.ts
  • LatLong.ts
  • Lazy.ts
  • Literal.ts
  • MapFromEntries.ts
  • Natural.ts
  • NegativeFloat.ts
  • NegativeInt.ts
  • Newtype.ts
  • NonEmptyArray.ts
  • NonEmptyString.ts
  • NonNegativeFloat.ts
  • NonPositiveFloat.ts
  • NonPositiveInt.ts
  • Nullable.ts
  • Number.ts
  • Option.ts
  • OptionFromNullable.ts
  • Optional.ts
  • Parse.ts
  • ParseBase64Json.ts
  • ParseEncodedJson.ts
  • ParseJsonString.ts
  • Partial.ts
  • Pattern.ts
  • PositiveFloat.ts
  • PositiveInt.ts
  • RGB.ts
  • Readonly.ts
  • Record.ts
  • Refine.ts
  • SetFromArray.ts
  • Strict.ts
  • String.ts
  • Struct.ts
  • Tuple.ts
  • UUID.ts
  • Union.ts
  • Unknown.ts
  • UnknownArray.ts
  • UnknownRecord.ts

Metadata

Metadata

Assignees

No one assigned

    Labels

    help wantedExtra attention is needed

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions