From 49dfec96bc40dd906dbfcbced3086a6bfdefea3f Mon Sep 17 00:00:00 2001 From: daffl Date: Tue, 28 Feb 2023 16:01:44 -0800 Subject: [PATCH 1/2] chore(docs): Some small documentation updates --- README.md | 4 - docs/api/databases/mongodb.md | 6 + docs/api/schema/typebox.md | 2 + docs/guides/basics/starting.md | 2 +- docs/package-lock.json | 17355 +++++++++++++++++++++++++++++++ docs/package.json | 2 +- 6 files changed, 17365 insertions(+), 6 deletions(-) create mode 100644 docs/package-lock.json diff --git a/README.md b/README.md index 4aaa84b45c..09d1d93d31 100644 --- a/README.md +++ b/README.md @@ -26,10 +26,6 @@ $ npm run dev To learn more about Feathers visit the website at [feathersjs.com](http://feathersjs.com) or jump right into [the Feathers guides](https://feathersjs.com/guides/). -# Documentation - -The [Feathers website](http://feathersjs.com) are loaded with awesome stuff and tell you every thing you need to know about using and configuring Feathers. - # License Copyright (c) 2023 [Feathers contributors](https://github.com/feathersjs/feathers/graphs/contributors) diff --git a/docs/api/databases/mongodb.md b/docs/api/databases/mongodb.md index 542f1dd3db..0c53207c67 100644 --- a/docs/api/databases/mongodb.md +++ b/docs/api/databases/mongodb.md @@ -435,6 +435,12 @@ The `ObjectIdSchema` helper will only work when the [`objectid` AJV keyword](#aj While the AJV format checks if an object id is valid, it still needs to be converted to the right type. An alternative the the [AJV converter](#ajv-converter) is to use [Feathers resolvers](../schema/resolvers.md). The following [property resolver](../schema/resolvers.md) helpers can be used. +
+ +ObjectId resolvers do not need to be used when using the [AJV keyword](#ajv-keyword). They are useful however when using another JSON schema validation library. + +
+ #### resolveObjectId `resolveObjectId` resolves a property as an object id. It can be used as a direct property resolver or called with the original value. diff --git a/docs/api/schema/typebox.md b/docs/api/schema/typebox.md index af0f42e1e4..2d1a550f88 100644 --- a/docs/api/schema/typebox.md +++ b/docs/api/schema/typebox.md @@ -1686,3 +1686,5 @@ Use `Type.Ref(...)` to create referenced types. The target type must specify an const T = Type.String({ $id: 'T' }) const R = Type.Ref(T) ``` + +For a more example see the [result and data schema](#result-and-data-schemas) section. diff --git a/docs/guides/basics/starting.md b/docs/guides/basics/starting.md index 8d35b67ac5..7765c4a8cd 100644 --- a/docs/guides/basics/starting.md +++ b/docs/guides/basics/starting.md @@ -380,7 +380,7 @@ In the same folder, add the following `index.html` page:

Messages

- +