chore(docs): Add @pre flag to all installation commands (#2940)

daffl · web-flow · commit a443673ff6f6 · 2022-12-18T16:36:50.000-08:00
diff --git a/docs/api/application.md b/docs/api/application.md
@@ -12,7 +12,7 @@ outline: deep
 </Badges>
 
 ```
-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
@@ -12,7 +12,7 @@ outline: deep
 </Badges>
 
 ```
-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
@@ -12,7 +12,7 @@ outline: deep
 </Badges>
 
 ```
-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
@@ -12,7 +12,7 @@ outline: deep
 </Badges>
 
 ```
-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
@@ -12,7 +12,7 @@ outline: deep
 </Badges>
 
 ```
-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
@@ -12,7 +12,7 @@ outline: deep
 </Badges>
 
 ```
-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
@@ -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
 </Badges>
 
 ```
-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 `<script>` tag and in most other JavaScript runtimes.
diff --git a/docs/api/client/rest.md b/docs/api/client/rest.md
@@ -19,7 +19,7 @@ The following chapter describes the use of
 </Badges>
 
 ```
-npm install @feathersjs/rest-client --save
+npm install @feathersjs/rest-client@pre --save
 ```
 
 `@feathersjs/rest-client` allows to connect to a service exposed through a REST HTTP transport (e.g. with [Koa](../koa.md#rest) or [Express](../express.md#rest)) using [fetch](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API), [Superagent](http://visionmedia.github.io/superagent/) or [Axios](https://github.com/mzabriskie/axios).
diff --git a/docs/api/client/socketio.md b/docs/api/client/socketio.md
@@ -14,7 +14,7 @@ outline: deep
 </Badges>
 
 ```
-npm install @feathersjs/socketio-client --save
+npm install @feathersjs/socketio-client@pre --save
 ```
 
 The `@feathersjs/socketio-client` module allows to connect to services exposed through the [Socket.io transport](../socketio.md) via a Socket.io socket. We recommend using Feathers and the `@feathersjs/socketio-client` module on the client if possible since it can also handle reconnection and reauthentication. If however, you want to use a direct Socket.io connection without using Feathers on the client, see the [Direct connection](#direct-connection) section.
diff --git a/docs/api/errors.md b/docs/api/errors.md
@@ -12,7 +12,7 @@ outline: deep
 </Badges>
 
 ```
-npm install @feathersjs/errors --save
+npm install @feathersjs/errors@pre --save
 ```
 
 The `@feathersjs/errors` module contains a set of standard error classes used by all other Feathers modules.
diff --git a/docs/api/express.md b/docs/api/express.md
@@ -12,7 +12,7 @@ outline: deep
 </Badges>
 
 ```
-npm install @feathersjs/express --save
+npm install @feathersjs/express@pre --save
 ```
 
 The `@feathersjs/express` module contains [Express](http://expressjs.com/) framework integrations for Feathers:
diff --git a/docs/api/koa.md b/docs/api/koa.md
@@ -12,7 +12,7 @@ outline: deep
 </Badges>
 
 ```
-npm install @feathersjs/koa --save
+npm install @feathersjs/koa@pre --save
 ```
 
 The `@feathersjs/koa` module contains the [KoaJS](https://koajs.com/) framework integrations for Feathers. It will turn the Feathers app into a fully compatible KoaJS application.
diff --git a/docs/api/socketio.md b/docs/api/socketio.md
@@ -12,7 +12,7 @@ outline: deep
 </Badges>
 
 ```
-npm install @feathersjs/socketio --save
+npm install @feathersjs/socketio@pre --save
 ```
 
 The [@feathersjs/socketio](https://github.com/feathersjs/socketio) module allows to call [service methods](./services.md) and receive [real-time events](./events.md) via [Socket.io](http://socket.io/), a NodeJS library which enables real-time bi-directional, event-based communication.
diff --git a/docs/guides/cli/service.class.md b/docs/guides/cli/service.class.md
@@ -14,7 +14,7 @@ When using a database, the service class will be extended from the [Feathers dat
 
 <BlockQuote type="tip" label="Note">
 
-The generic types for a database service are always `AdapterService<MessageType, DataType, ParamsType, PatchType>`. The `MessageService<MessageParams extends Params = MessageParams>` generic is used to change the parameter type when using this service interface as a [client side service](./client.md).
+The generic types for a database service are always `AdapterService<MessageType, DataType, ParamsType, PatchType>`. The `MessageService<ServiceParams extends Params = MessageParams>` generic is used to change the parameter type when using this service interface as a [client side service](./client.md).
 
 </BlockQuote>
 
@@ -34,7 +34,7 @@ import { Id, NullableId, Paginated } from '@feathersjs/feathers'
 export interface MessageParams extends KnexAdapterParams<MessageQuery> {}
 
 // By default calls the standard Knex adapter service methods but can be customized with your own functionality.
-export class MessageService<MessageParams extends Params = MessageParams> extends KnexService<
+export class MessageService<ServiceParams extends Params = MessageParams> extends KnexService<
   Message,
   MessageData,
   MessageParams,
@@ -43,35 +43,35 @@ export class MessageService<MessageParams extends Params = MessageParams> extend
   async find(
     params?: MessageParams & { paginate?: { default?: number; max?: number } }
   ): Promise<Paginated<Message>>
-  async find(params?: MessageParams & { paginate: false }): Promise<Message[]>
-  async find(params?: MessageParams): Promise<Paginated<Message> | Message[]>
-  async find(params?: MessageParams): Promise<Paginated<Message> | Message[]> {
+  async find(params?: ServiceParams & { paginate: false }): Promise<Message[]>
+  async find(params?: ServiceParams): Promise<Paginated<Message> | Message[]>
+  async find(params?: ServiceParams): Promise<Paginated<Message> | Message[]> {
     return super.find(params)
   }
 
-  async get(id: Id, params?: MessageParams): Promise<Message> {
+  async get(id: Id, params?: ServiceParams): Promise<Message> {
     return super.get(id, params)
   }
 
-  async create(data: MessageData, params?: MessageParams): Promise<Message>
-  async create(data: MessageData[], params?: MessageParams): Promise<Message[]>
-  async create(data: MessageData | MessageData[], params?: MessageParams): Promise<Message | Message[]> {
+  async create(data: MessageData, params?: ServiceParams): Promise<Message>
+  async create(data: MessageData[], params?: ServiceParams): Promise<Message[]>
+  async create(data: MessageData | MessageData[], params?: ServiceParams): Promise<Message | Message[]> {
     return super.create(data, params)
   }
 
-  async update(id: Id, data: Data, params?: MessageParams): Promise<Message> {
+  async update(id: Id, data: Data, params?: ServiceParams): Promise<Message> {
     return super.update(id, data, params)
   }
 
-  async patch(id: Id, data: MessagePatch, params?: MessageParams): Promise<Message>
-  async patch(id: null, data: MessagePatch, params?: MessageParams): Promise<Message[]>
-  async patch(id: NullableId, data: MessagePatch, params?: MessageParams): Promise<Message | Message[]> {
+  async patch(id: Id, data: MessagePatch, params?: ServiceParams): Promise<Message>
+  async patch(id: null, data: MessagePatch, params?: ServiceParams): Promise<Message[]>
+  async patch(id: NullableId, data: MessagePatch, params?: ServiceParams): Promise<Message | Message[]> {
     return super.patch(id, data, params)
   }
 
-  async remove(id: Id, params?: MessageParams): Promise<Message>
-  async remove(id: null, params?: MessageParams): Promise<Message[]>
-  async remove(id: NullableId, params?: MessageParams): Promise<Message | Message[]> {
+  async remove(id: Id, params?: ServiceParams): Promise<Message>
+  async remove(id: null, params?: ServiceParams): Promise<Message[]>
+  async remove(id: NullableId, params?: ServiceParams): Promise<Message | Message[]> {
     return super.remove(id, params)
   }
 }
@@ -90,48 +90,48 @@ import { AdapterId } from '@feathersjs/mongodb'
 export interface MessageParams extends MongoDBAdapterParams<MessageQuery> {}
 
 // By default calls the standard MongoDB adapter service methods but can be customized with your own functionality.
-export class MessageService<MessageParams extends Params = MessageParams> extends MongoDBService<
+export class MessageService<ServiceParams extends Params = MessageParams> extends MongoDBService<
   Message,
   MessageData,
   MessageParams,
   MessagePatch
 > {
   async find(
-    params?: MessageParams & { paginate?: { paginate?: { default?: number; max?: number } } }
+    params?: ServiceParams & { paginate?: { paginate?: { default?: number; max?: number } } }
   ): Promise<Paginated<Message>>
-  async find(params?: MessageParams & { paginate: false }): Promise<Message[]>
-  async find(params?: MessageParams): Promise<Paginated<Message> | Message[]>
-  async find(params?: MessageParams): Promise<Paginated<Message> | Message[]> {
+  async find(params?: ServiceParams & { paginate: false }): Promise<Message[]>
+  async find(params?: ServiceParams): Promise<Paginated<Message> | Message[]>
+  async find(params?: ServiceParams): Promise<Paginated<Message> | Message[]> {
     return super.find(params)
   }
 
-  async get(id: AdapterId, params?: MessageParams): Promise<Message> {
+  async get(id: AdapterId, params?: ServiceParams): Promise<Message> {
     return super.get(id, params)
   }
 
-  async create(data: MessageData, params?: MessageParams): Promise<Message>
-  async create(data: MessageData[], params?: MessageParams): Promise<Message[]>
-  async create(data: MessageData | MessageData[], params?: MessageParams): Promise<Message | Message[]> {
+  async create(data: MessageData, params?: ServiceParams): Promise<Message>
+  async create(data: MessageData[], params?: ServiceParams): Promise<Message[]>
+  async create(data: MessageData | MessageData[], params?: ServiceParams): Promise<Message | Message[]> {
     return super.create(data, params)
   }
 
-  async update(id: AdapterId, data: MessageData, params?: MessageParams): Promise<Message> {
+  async update(id: AdapterId, data: MessageData, params?: ServiceParams): Promise<Message> {
     return super.update(id, data, params)
   }
 
-  async patch(id: null, data: MessagePatch, params?: MessageParams): Promise<Message[]>
-  async patch(id: AdapterId, data: MessagePatch, params?: MessageParams): Promise<Message>
+  async patch(id: null, data: MessagePatch, params?: ServiceParams): Promise<Message[]>
+  async patch(id: AdapterId, data: MessagePatch, params?: ServiceParams): Promise<Message>
   async patch(
     id: NullableAdapterId,
     data: MessagePatch,
-    params?: MessageParams
+    params?: ServiceParams
   ): Promise<Message | Message[]> {
     return super.patch(id, data, params)
   }
 
-  async remove(id: AdapterId, params?: MessageParams): Promise<Message>
-  async remove(id: null, params?: MessageParams): Promise<Message[]>
-  async remove(id: NullableAdapterId, params?: MessageParams): Promise<Message | Message[]> {
+  async remove(id: AdapterId, params?: ServiceParams): Promise<Message>
+  async remove(id: null, params?: ServiceParams): Promise<Message[]>
+  async remove(id: NullableAdapterId, params?: ServiceParams): Promise<Message | Message[]> {
     return super.remove(id, params)
   }
 }
@@ -152,13 +152,13 @@ import { KnexAdapter } from '@feathersjs/knex'
 export interface MessageParams extends KnexAdapterParams<MessageQuery> {}
 
 // By default calls the standard Knex adapter service methods but can be customized with your own functionality.
-export class MessageService<MessageParams extends Params = MessageParams> extends KnexAdapter<
+export class MessageService<ServiceParams extends Params = MessageParams> extends KnexAdapter<
   Message,
   MessageData,
   MessageParams,
   MessagePatch
 > {
-  async find(params: MessageParams) {
+  async find(params: ServiceParams) {
     const page = this._find(params)
 
     return {
@@ -167,7 +167,7 @@ export class MessageService<MessageParams extends Params = MessageParams> extend
     }
   }
 
-  async get(id: Id, params: MessageParams) {
+  async get(id: Id, params: ServiceParams) {
     return {
       message: `Hello ${id}`
     }
@@ -188,13 +188,13 @@ import { MongoDbAdapter } from '@feathersjs/mongodb'
 export interface MessageParams extends MongoDBAdapterParams<MessageQuery> {}
 
 // By default calls the standard MongoDB adapter service methods but can be customized with your own functionality.
-export class MessageService<MessageParams extends Params = MessageParams> extends MongoDbAdapter<
+export class MessageService<ServiceParams extends Params = MessageParams> extends MongoDbAdapter<
   Message,
   MessageData,
   MessageParams,
   MessagePatch
 > {
-  async find(params: MessageParams) {
+  async find(params: ServiceParams) {
     const page = this._find(params)
 
     return {
@@ -203,7 +203,7 @@ export class MessageService<MessageParams extends Params = MessageParams> extend
     }
   }
 
-  async get(id: Id, params: MessageParams) {
+  async get(id: Id, params: ServiceParams) {
     return {
       message: `Hello ${id}`
     }
@@ -225,13 +225,13 @@ export interface MessageParams extends KnexAdapterParams<MessageQuery> {}
 export type MyMethodData = { greeting: string }
 
 // By default calls the standard Knex adapter service methods but can be customized with your own functionality.
-export class MessageService<MessageParams extends Params = MessageParams> extends KnexService<
+export class MessageService<ServiceParams extends Params = MessageParams> extends KnexService<
   Message,
   MessageData,
   MessageParams,
   MessagePatch
 > {
-  async myMethod(data: MyMethodData, params: MessageParams) {
+  async myMethod(data: MyMethodData, params: ServiceParams) {
     return {
       message: `${data.greeting || 'Hello'} ${params.user.name}!`
     }
@@ -251,13 +251,13 @@ export interface MessageParams extends MongoDBAdapterParams<MessageQuery> {}
 export type MyMethodData = { name: string }
 
 // By default calls the standard MongoDB adapter service methods but can be customized with your own functionality.
-export class MessageService<MessageParams extends Params = MessageParams> extends MongoDBService<
+export class MessageService<ServiceParams extends Params = MessageParams> extends MongoDBService<
   Message,
   MessageData,
   MessageParams,
   MessagePatch
 > {
-  async myMethod(data: MyMethodData, params: MessageParams) {
+  async myMethod(data: MyMethodData, params: ServiceParams) {
     return {
       message: `${data.greeting || 'Hello'} ${params.user.name}!`
     }
