Merge pull request #48 from seasonedcc/update-examples

Update arktype and remix examples and add docs and an adapter to arktype

README.md

@@ -29,6 +29,7 @@ A set of types and functions to make compositions easy and safe.
     - [Migrating from domain-functions](#migrating-from-domain-functions)
     - [Handling external input](#handling-external-input)
     - [Defining constants for multiple functions (environments)](#defining-constants-for-multiple-functions-environments)
+    - [Using custom parsers](#using-custom-parsers)
 - [Using Deno](#using-deno)
 - [Acknowledgements](#acknowledgements)
 
@@ -254,6 +255,7 @@ const getProfile = composable(async (id: string) => {
 #### [Migrating from domain-functions](./migrating-df.md)
 #### [Handling external input](./with-schema.md)
 #### [Defining constants for multiple functions (environments)](./environments.md)
+#### [Using custom parsers](./examples/arktype/README.md)
 
 ## Using Deno
 

examples/arktype/README.md

@@ -0,0 +1,9 @@
+# Use composable-functions with a custom parser
+
+This simple example can be a reference to adapt composable-functions to any other parser library.
+
+There are two approaches to use composable-functions with a custom parser:
+- Create an adapter function that will receive a schema and return a schema in the shape of a `ParserSchena`. Example: [the `adapt` function](./src/adapters.ts).
+- Create your custom `withSchema` and `applySchema` that will validate your input and environment and return a `Result`. Example: [the `withArkSchema` and `applyArkSchema` functions](./src/adapters.ts).
+
+Check out the [`./src`](./src/) directory to understand how we implemented both approaches with [`arktype`](https://github.com/arktypeio/arktype).

examples/arktype/package.json

@@ -3,9 +3,9 @@
   "private": true,
   "version": "0.0.0",
   "type": "module",
-  "main": "src/index.ts",
+  "main": "src/usage.ts",
   "scripts": {
-    "dev": "tsx src/index.ts"
+    "dev": "tsx src/usage.ts"
   },
   "devDependencies": {
     "tsx": "^4.7.2"