Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Additional Documentation and Examples #280

Open
73 tasks
jacob-alford opened this issue Jul 30, 2023 · 0 comments
Open
73 tasks

Additional Documentation and Examples #280

jacob-alford opened this issue Jul 30, 2023 · 0 comments
Labels
help wanted Extra attention is needed

Comments

@jacob-alford
Copy link
Owner

jacob-alford commented Jul 30, 2023

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
@jacob-alford jacob-alford added the help wanted Extra attention is needed label Jul 30, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant