E5EE docs: Some small documentation updates by daffl · Pull Request #3085 · feathersjs/feathers · GitHub
[go: up one dir, main page]
Skip to content

docs: Some small documentation updates #3085

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.

Sign up for GitHub

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

Merged
daffl merged 2 commits into from
Mar 15, 2023
Merged

docs: Some small documentation updates #3085

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
49dfec9
chore(docs): Some small documentation updates
daffl Mar 1, 2023
4bb736a
Fix language
daffl Mar 15, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
6 changes: 6 additions & 0 deletions docs/api/databases/mongodb.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<BlockQuote type="warning" label="Important">

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.

</BlockQuote>

#### resolveObjectId

`resolveObjectId` resolves a property as an object id. It can be used as a direct property resolver or called with the original value.
Expand Down
2 changes: 2 additions & 0 deletions docs/api/schema/typebox.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 detailed example see the [result and data schema](#result-and-data-schemas) section.
2 changes: 1 addition & 1 deletion docs/guides/basics/starting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -380,7 +380,7 @@ In the same folder, add the following `index.html` page:
<h2 class="pt-1 pb-2 text-lg">Messages</h2>
</main>

<script src="//unpkg.com/@feathersjs/client@^5.0.0-pre.34/dist/feathers.js"></script>
<script src="//unpkg.com/@feathersjs/client@^5.0.0/dist/feathers.js"></script>
<script src="/socket.io/socket.io.js"></script>
<script type="text/javascript">
// Set up socket.io
Expand Down
Loading
0