chore: updated docs

Author: jessekelly881

.gitignore

@@ -2,4 +2,5 @@ node_modules/
 dist/
 yarn-error.log
 docs/modules/*.ts.md
-docs/_site
+docs/_sitedocs
+docs/

src/Alpha.ts

@@ -1,28 +1,25 @@
+/**
+ * @since 1.0.0
+ */
 import * as t from "io-ts";
 import isAlpha from "validator/lib/isAlpha";
 
-/*
- * @categorty type
+/**
  * @since 1.0.0
  */
-interface AlphaBrand {
+export interface AlphaBrand {
   readonly Alpha: unique symbol;
 }
 
-/*
+/**
  * @categorty type
  * @since 1.0.0
  */
-type Alpha = t.Branded<string, AlphaBrand>;
+export type Alpha = t.Branded<string, AlphaBrand>;
 
-/*
-
- * A string that only includes alpha characters. E.g. a, b, c, A, B, C
- *
- * @categorty codec
- * @since 1.0. 0
+/**
+ * @since 1.0.0
  */
-const Alpha = t.brand(t.string, (s): s is Alpha => isAlpha(s), "Alpha");
+export const Alpha = t.brand(t.string, (s): s is Alpha => isAlpha(s), "Alpha");
 
-export { Alpha, AlphaBrand };
 export default Alpha;

src/AlphaNumeric.ts

@@ -1,12 +1,24 @@
+/**
+ * @since 1.0.0
+ */
 import * as t from "io-ts";
 import isAlphaNumeric from "validator/lib/isAlphanumeric";
 
-interface AlphaNumericBrand {
+/**
+ * @since 1.0.0
+ */
+export interface AlphaNumericBrand {
   readonly AlphaNumeric: unique symbol;
 }
 
-type AlphaNumeric = t.Branded<string, AlphaNumericBrand>;
-const AlphaNumeric = t.brand(t.string, (s): s is AlphaNumeric => isAlphaNumeric(s), "AlphaNumeric");
+/**
+ * @since 1.0.0
+ */
+export type AlphaNumeric = t.Branded<string, AlphaNumericBrand>;
+
+/**
+ * @since 1.0.0
+ */
+export const AlphaNumeric = t.brand(t.string, (s): s is AlphaNumeric => isAlphaNumeric(s), "AlphaNumeric");
 
-export { AlphaNumeric, AlphaNumericBrand };
 export default AlphaNumeric;

src/Ascii.ts

@@ -1,12 +1,25 @@
+/**
+ * @since 1.0.0
+ */
 import * as t from "io-ts";
 import isAscii from "validator/lib/isAscii";
 
-interface AsciiBrand {
+
+/**
+ * @since 1.0.0
+ */
+export interface AsciiBrand {
   readonly Ascii: unique symbol;
 }
 
-type Ascii = t.Branded<string, AsciiBrand>;
-const Ascii = t.brand(t.string, (s): s is Ascii => isAscii(s), "Ascii");
+/**
+ * @since 1.0.0
+ */
+export type Ascii = t.Branded<string, AsciiBrand>;
+
+/**
+ * @since 1.0.0
+ */
+export const Ascii = t.brand(t.string, (s): s is Ascii => isAscii(s), "Ascii");
 
-export { Ascii, AsciiBrand };
 export default Ascii;

src/BIC.ts

@@ -1,12 +1,24 @@
+/**
+ * @since 1.0.0
+ */
 import * as t from 'io-ts'
 import isBIC from 'validator/lib/isBIC'
 
-interface BICBrand {
+/**
+ * @since 1.0.0
+ */
+export interface BICBrand {
   readonly BIC: unique symbol
 }
 
-type BIC = t.Branded<string, BICBrand>
-const BIC = t.brand(t.string, (s): s is BIC => isBIC(s), 'BIC')
+/**
+ * @since 1.0.0
+ */
+export type BIC = t.Branded<string, BICBrand>
+
+/**
+ * @since 1.0.0
+ */
+export const BIC = t.brand(t.string, (s): s is BIC => isBIC(s), 'BIC')
 
-export { BIC, BICBrand }
 export default BIC

src/Base.ts

@@ -1,3 +1,6 @@
+/**
+ * @since 1.0.0
+ */
 import * as t from "io-ts";
 import isBase32 from "validator/lib/isBase32";
 import isBase58 from "validator/lib/isBase58";
@@ -7,45 +10,66 @@ import isBase64 from "validator/lib/isBase64";
  * Base 32 Encoded
  */
 
-interface Base32Brand {
+/**
+ * @since 1.0.0
+ */
+export interface Base32Brand {
   readonly Base32: unique symbol;
 }
 
-type Base32 = t.Branded<string, Base32Brand>;
-const Base32 = t.brand(t.string, (s): s is Base32 => isBase32(s), "Base32");
+/**
+ * @since 1.0.0
+ */
+export type Base32 = t.Branded<string, Base32Brand>;
+
+/**
+ * @since 1.0.0
+ */
+export const Base32 = t.brand(t.string, (s): s is Base32 => isBase32(s), "Base32");
 
 
 /*
  * Base 58 Encoded
  */
 
-interface Base58Brand {
+/**
+ * @since 1.0.0
+ */
+export interface Base58Brand {
   readonly Base58: unique symbol;
 }
 
-type Base58 = t.Branded<string, Base58Brand>;
-const Base58 = t.brand(t.string, (s): s is Base58 => isBase58(s), "Base58");
+/**
+ * @since 1.0.0
+ */
+export type Base58 = t.Branded<string, Base58Brand>;
+
+/**
+ * @since 1.0.0
+ */
+export const Base58 = t.brand(t.string, (s): s is Base58 => isBase58(s), "Base58");
 
 
 /*
  * Base 64 Encoded
  */
 
-interface Base64Brand {
+/**
+ * @since 1.0.0
+ */
+export interface Base64Brand {
   readonly Base64: unique symbol;
 }
 
-type Base64 = t.Branded<string, Base64Brand>;
-const Base64 = t.brand(t.string, (s): s is Base64 => isBase64(s), "Base64");
+/**
+ * @since 1.0.0
+ */
+export type Base64 = t.Branded<string, Base64Brand>;
 
+/**
+ * @since 1.0.0
+ */
+export const Base64 = t.brand(t.string, (s): s is Base64 => isBase64(s), "Base64");
 
-export {
-  Base32,
-  Base32Brand,
-  Base58,
-  Base58Brand,
-  Base64,
-  Base64Brand
-}
 
 export default Base32;

src/BitcoinAddress.ts

@@ -1,18 +1,29 @@
+/**
+ * @since 1.0.0
+ */
 import * as t from "io-ts";
 import isBtcAddress from "validator/lib/isBtcAddress";
 
-interface BitcoinAddressBrand {
+/**
+ * @since 1.0.0
+ */
+export interface BitcoinAddressBrand {
   readonly BitcoinAddress: unique symbol;
 }
 
-type BitcoinAddress = t.Branded<string, BitcoinAddressBrand>;
+/**
+ * @since 1.0.0
+ */
+export type BitcoinAddress = t.Branded<string, BitcoinAddressBrand>;
 
-const BitcoinAddress = t.brand(
+/**
+ * @since 1.0.0
+ */
+export const BitcoinAddress = t.brand(
   t.string,
   (s): s is BitcoinAddress => isBtcAddress(s),
   "BitcoinAddress"
 );
 
 
-export { BitcoinAddress, BitcoinAddressBrand }
 export default BitcoinAddress;

src/Char.ts

@@ -1,22 +1,32 @@
+/**
+ * A string of length one. E.g. "a
+ * "
+ *
+ * @since 1.0.0
+ */
 import * as t from "io-ts";
 import isLength from "validator/lib/isLength";
 
-/*
- * Char - A string of length one
+/**
+ * @since 1.0.0
  */
-
-interface CharBrand {
+export interface CharBrand {
   readonly Char: unique symbol;
 }
 
-type Char = t.Branded<string, CharBrand>;
+/**
+ * @since 1.0.0
+ */
+export type Char = t.Branded<string, CharBrand>;
 
-const Char = t.brand(
+/**
+ * @since 1.0.0
+ */
+export const Char = t.brand(
   t.string,
   (s): s is Char => isLength(s, { min: 1, max: 1 }),
   "Char"
 );
 
 
-export { Char, CharBrand }
 export default Char;