From a443673ff6f69612085f41086f46e17e6e105676 Mon Sep 17 00:00:00 2001 From: David Luecke Date: Sun, 18 Dec 2022 16:36:50 -0800 Subject: [PATCH] chore(docs): Add @pre flag to all installation commands (#2940) --- docs/api/application.md | 2 +- docs/api/authentication/client.md | 2 +- docs/api/authentication/jwt.md | 2 +- docs/api/authentication/local.md | 2 +- docs/api/authentication/oauth.md | 2 +- docs/api/authentication/service.md | 2 +- docs/api/client.md | 6 +-- docs/api/client/rest.md | 2 +- docs/api/client/socketio.md | 2 +- docs/api/errors.md | 2 +- docs/api/express.md | 2 +- docs/api/koa.md | 2 +- docs/api/socketio.md | 2 +- docs/guides/cli/service.class.md | 84 +++++++++++++++--------------- 14 files changed, 57 insertions(+), 57 deletions(-) diff --git a/docs/api/application.md b/docs/api/application.md index 3228b01670..4387566e9b 100644 --- a/docs/api/application.md +++ b/docs/api/application.md @@ -12,7 +12,7 @@ outline: deep ``` -npm install @feathersjs/feathers --save +npm install @feathersjs/feathers@pre --save ``` The core `@feathersjs/feathers` module provides the ability to initialize a new Feathers application instance. It works in Node, React Native and the browser (see the [client](./client.md) chapter for more information). Each instance allows for registration and retrieval of [services](./services.md), [hooks](./hooks.md), plugin configuration, and getting and setting configuration options. An initialized Feathers application is referred to as the **app object**. diff --git a/docs/api/authentication/client.md b/docs/api/authentication/client.md index 46ffd3c69d..bee0669e1f 100644 --- a/docs/api/authentication/client.md +++ b/docs/api/authentication/client.md @@ -12,7 +12,7 @@ outline: deep ``` -npm install @feathersjs/authentication-client --save +npm install @feathersjs/authentication-client@pre --save ``` The `@feathersjs/authentication-client` module allows you to easily authenticate a Feathers client against a Feathers server. It is not required, but makes it easier to implement authentication in your client by automatically storing and sending the access token and handling re-authenticating when a websocket disconnects. diff --git a/docs/api/authentication/jwt.md b/docs/api/authentication/jwt.md index 88d562bbb8..23234f0645 100644 --- a/docs/api/authentication/jwt.md +++ b/docs/api/authentication/jwt.md @@ -12,7 +12,7 @@ outline: deep ``` -npm install @feathersjs/authentication --save +npm install @feathersjs/authentication@pre --save ``` The `JWTStrategy` is an [authentication strategy](./strategy.md) included in `@feathersjs/authentication` for authenticating [JSON web tokens (JWT)](https://jwt.io/): diff --git a/docs/api/authentication/local.md b/docs/api/authentication/local.md index 8a0e0f8a25..1e56613a9c 100644 --- a/docs/api/authentication/local.md +++ b/docs/api/authentication/local.md @@ -12,7 +12,7 @@ outline: deep ``` -npm install @feathersjs/authentication-local --save +npm install @feathersjs/authentication-local@pre --save ``` `@feathersjs/authentication-local` provides a `LocalStrategy` for authenticating with a username/email and password combination, e.g. diff --git a/docs/api/authentication/oauth.md b/docs/api/authentication/oauth.md index 202287203c..2300adaec1 100644 --- a/docs/api/authentication/oauth.md +++ b/docs/api/authentication/oauth.md @@ -12,7 +12,7 @@ outline: deep ``` -npm install @feathersjs/authentication-oauth --save +npm install @feathersjs/authentication-oauth@pre --save ``` `@feathersjs/authentication-oauth` allows to authenticate with over 180 OAuth providers (Google, Facebook, GitHub etc.) using [grant](https://github.com/simov/grant), an OAuth middleware module for NodeJS. diff --git a/docs/api/authentication/service.md b/docs/api/authentication/service.md index 0dff03e98b..87fa9c7556 100644 --- a/docs/api/authentication/service.md +++ b/docs/api/authentication/service.md @@ -12,7 +12,7 @@ outline: deep ``` -npm install @feathersjs/authentication --save +npm install @feathersjs/authentication@pre --save ``` The `AuthenticationService` is a [Feathers service](../services.md) that allows to register different [authentication strategies](./strategy.md) and manage access tokens (using [JSON web tokens (JWT)](https://jwt.io/) by default). This section describes diff --git a/docs/api/client.md b/docs/api/client.md index 3e38bdf4ce..7671c4edcb 100644 --- a/docs/api/client.md +++ b/docs/api/client.md @@ -32,7 +32,7 @@ A Feathers application generated with Feathers v5 or later now exports a client To connect to a Feathers server in NodeJS, install the desired client connection library (here, `socket.io-client`), alongside the Feathers core library, and the connection-specific library: ``` -npm install @feathersjs/feathers @feathersjs/socketio-client socket.io-client --save +npm install @feathersjs/feathers@pre @feathersjs/socketio-client@pre socket.io-client --save ``` Then initialize like this: @@ -62,7 +62,7 @@ messageService.create({ React Native usage is the same as for the [Node client](#node). Install the required packages into your [React Native](https://facebook.github.io/react-native/) project. ```bash -npm install @feathersjs/feathers @feathersjs/socketio-client socket.io-client +npm install @feathersjs/feathers@pre @feathersjs/socketio-client@pre socket.io-client ``` Then in the main application file: @@ -138,7 +138,7 @@ For non-CommonJS formats (like AMD) version of Feathers and its client modules t ``` -npm install @feathersjs/client --save +npm install @feathersjs/client@pre --save ``` `@feathersjs/client` is a module that bundles the separate Feathers client-side modules into one file which can be loaded directly in the browser through a `