Skip to content

Commit

Permalink
chore: prettier update
Browse files Browse the repository at this point in the history
  • Loading branch information
pozil committed Nov 28, 2024
1 parent 6cce6a6 commit 8d5d560
Show file tree
Hide file tree
Showing 2 changed files with 53 additions and 53 deletions.
62 changes: 31 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,29 +4,29 @@

See the [official Pub/Sub API repo](https://github.com/developerforce/pub-sub-api) and the [documentation](https://developer.salesforce.com/docs/platform/pub-sub-api/guide/intro.html) for more information on the Salesforce gRPC-based Pub/Sub API.

- [v4 to v5 Migration](#v4-to-v5-migration)
- [v4 Documentation](v4-documentation.md)
- [Installation and Configuration](#installation-and-configuration)
- [Authentication](#authentication)
- [User supplied authentication](#user-supplied-authentication)
- [Username/password flow](#usernamepassword-flow)
- [OAuth 2.0 client credentials flow (client_credentials)](#oauth-20-client-credentials-flow-client_credentials)
- [OAuth 2.0 JWT bearer flow](#oauth-20-jwt-bearer-flow)
- [Logging](#logging)
- [Quick Start Example](#quick-start-example)
- [Other Examples](#other-examples)
- [Publish a platform event](#publish-a-platform-event)
- [Subscribe with a replay ID](#subscribe-with-a-replay-id)
- [Subscribe to past events in retention window](#subscribe-to-past-events-in-retention-window)
- [Work with flow control for high volumes of events](#work-with-flow-control-for-high-volumes-of-events)
- [Handle gRPC stream lifecycle events](#handle-grpc-stream-lifecycle-events)
- [Common Issues](#common-issues)
- [Reference](#reference)
- [PubSubApiClient](#pubsubapiclient)
- [SubscribeCallback](#subscribecallback)
- [SubscriptionInfo](#subscriptioninfo)
- [EventParseError](#eventparseerror)
- [Configuration](#configuration)
- [v4 to v5 Migration](#v4-to-v5-migration)
- [v4 Documentation](v4-documentation.md)
- [Installation and Configuration](#installation-and-configuration)
- [Authentication](#authentication)
- [User supplied authentication](#user-supplied-authentication)
- [Username/password flow](#usernamepassword-flow)
- [OAuth 2.0 client credentials flow (client_credentials)](#oauth-20-client-credentials-flow-client_credentials)
- [OAuth 2.0 JWT bearer flow](#oauth-20-jwt-bearer-flow)
- [Logging](#logging)
- [Quick Start Example](#quick-start-example)
- [Other Examples](#other-examples)
- [Publish a platform event](#publish-a-platform-event)
- [Subscribe with a replay ID](#subscribe-with-a-replay-id)
- [Subscribe to past events in retention window](#subscribe-to-past-events-in-retention-window)
- [Work with flow control for high volumes of events](#work-with-flow-control-for-high-volumes-of-events)
- [Handle gRPC stream lifecycle events](#handle-grpc-stream-lifecycle-events)
- [Common Issues](#common-issues)
- [Reference](#reference)
- [PubSubApiClient](#pubsubapiclient)
- [SubscribeCallback](#subscribecallback)
- [SubscriptionInfo](#subscriptioninfo)
- [EventParseError](#eventparseerror)
- [Configuration](#configuration)

## v4 to v5 Migration

Expand All @@ -37,13 +37,13 @@ See the [official Pub/Sub API repo](https://github.com/developerforce/pub-sub-ap

In v4 and earlier versions of this client:

- you specify the configuration in a `.env` file with specific property names.
- you connect with either the `connect()` or `connectWithAuth()` method depending on the authentication flow.
- you specify the configuration in a `.env` file with specific property names.
- you connect with either the `connect()` or `connectWithAuth()` method depending on the authentication flow.

In v5:

- you pass your configuration with an object in the client constructor. The `.env` file is no longer a requirement, you are free to store your configuration where you want.
- you connect with a unique `connect()` method.
- you pass your configuration with an object in the client constructor. The `.env` file is no longer a requirement, you are free to store your configuration where you want.
- you connect with a unique `connect()` method.

### Event handling

Expand Down Expand Up @@ -80,10 +80,10 @@ Install the client library with `npm install salesforce-pubsub-api-client`.

Pick one of these authentication flows and pass the relevant configuration to the `PubSubApiClient` constructor:

- [User supplied authentication](#user-supplied-authentication)
- [Username/password flow](#usernamepassword-flow) (recommended for tests)
- [OAuth 2.0 client flow](#oauth-20-client-credentials-flow-client_credentials)
- [OAuth 2.0 JWT Bearer flow](#oauth-20-jwt-bearer-flow) (recommended for production)
- [User supplied authentication](#user-supplied-authentication)
- [Username/password flow](#usernamepassword-flow) (recommended for tests)
- [OAuth 2.0 client flow](#oauth-20-client-credentials-flow-client_credentials)
- [OAuth 2.0 JWT Bearer flow](#oauth-20-jwt-bearer-flow) (recommended for production)

#### User supplied authentication

Expand Down
44 changes: 22 additions & 22 deletions v4-documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,24 +3,24 @@
> [!INFO]
> This documentation is kept to support a legacy version. Please consider upgrading to the latest version.
- [Installation and Configuration](#installation-and-configuration)
- [User supplied authentication](#user-supplied-authentication)
- [Username/password flow](#usernamepassword-flow)
- [OAuth 2.0 client credentials flow (client_credentials)](#oauth-20-client-credentials-flow-client_credentials)
- [OAuth 2.0 JWT bearer flow](#oauth-20-jwt-bearer-flow)
- [Basic Example](#basic-example)
- [Other Examples](#other-examples)
- [Publish a platform event](#publish-a-platform-event)
- [Subscribe with a replay ID](#subscribe-with-a-replay-id)
- [Subscribe to past events in retention window](#subscribe-to-past-events-in-retention-window)
- [Work with flow control for high volumes of events](#work-with-flow-control-for-high-volumes-of-events)
- [Handle gRPC stream lifecycle events](#handle-grpc-stream-lifecycle-events)
- [Use a custom logger](#use-a-custom-logger)
- [Common Issues](#common-issues)
- [Reference](#reference)
- [PubSubApiClient](#pubsubapiclient)
- [PubSubEventEmitter](#pubsubeventemitter)
- [EventParseError](#eventparseerror)
- [Installation and Configuration](#installation-and-configuration)
- [User supplied authentication](#user-supplied-authentication)
- [Username/password flow](#usernamepassword-flow)
- [OAuth 2.0 client credentials flow (client_credentials)](#oauth-20-client-credentials-flow-client_credentials)
- [OAuth 2.0 JWT bearer flow](#oauth-20-jwt-bearer-flow)
- [Basic Example](#basic-example)
- [Other Examples](#other-examples)
- [Publish a platform event](#publish-a-platform-event)
- [Subscribe with a replay ID](#subscribe-with-a-replay-id)
- [Subscribe to past events in retention window](#subscribe-to-past-events-in-retention-window)
- [Work with flow control for high volumes of events](#work-with-flow-control-for-high-volumes-of-events)
- [Handle gRPC stream lifecycle events](#handle-grpc-stream-lifecycle-events)
- [Use a custom logger](#use-a-custom-logger)
- [Common Issues](#common-issues)
- [Reference](#reference)
- [PubSubApiClient](#pubsubapiclient)
- [PubSubEventEmitter](#pubsubeventemitter)
- [EventParseError](#eventparseerror)

## Installation and Configuration

Expand All @@ -30,10 +30,10 @@ Create a `.env` file at the root of the project for configuration.

Pick one of these authentication flows and fill the relevant configuration:

- User supplied authentication
- Username/password authentication (recommended for tests)
- OAuth 2.0 client credentials
- OAuth 2.0 JWT Bearer (recommended for production)
- User supplied authentication
- Username/password authentication (recommended for tests)
- OAuth 2.0 client credentials
- OAuth 2.0 JWT Bearer (recommended for production)

> [!TIP]
> The default client logger is fine for a test environment but you'll want to switch to a [custom logger](#use-a-custom-logger) with asynchronous logging for increased performance.
Expand Down

0 comments on commit 8d5d560

Please sign in to comment.