Skip to content

Commit

Permalink
Add deprecation notice to Node SDK (#1652)
Browse files Browse the repository at this point in the history
Co-authored-by: Alexis Aguilar <[email protected]>
  • Loading branch information
wobsoriano and alexisintech authored Oct 24, 2024
1 parent 3c30f1f commit 841b084
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 3 deletions.
9 changes: 6 additions & 3 deletions docs/backend-requests/handling/nodejs.mdx
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
---
title: Handling requests with Node.js and Express
description: Learn how to handle authenticated requests with Node.js and Express middleware using Clerk.
title: Handling requests with the Node SDK
description: Learn how to handle authenticated requests with Clerk's Node SDK.
---

## Node.js and Connect/Express Middleware
> [!CAUTION]
> On January 8, 2025, the Node SDK will no longer be available. [Upgrade to the Express SDK.](/docs/upgrade-guides/node-to-express)
## Node SDK Middleware

The Clerk Node SDK offers two authentication middlewares specifically for [Express](https://expressjs.com/) and Connect/Express compatible frameworks such as [Fastify](https://www.fastify.io/docs/latest/Reference/Middleware/).

Expand Down
5 changes: 5 additions & 0 deletions docs/references/express/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,11 @@ Clerk makes it simple to add authentication to your Express application. This do

See the [quickstart](/docs/quickstarts/express) to get started.

{/* TODO: Remove callout when Node SDK is removed from docs */}

> [!IMPORTANT]
> If you are upgrading from the Node SDK, see the [upgrade guide](/docs/upgrade-guides/node-to-express) for more information.
## Available methods

### `clerkMiddleware()`
Expand Down
3 changes: 3 additions & 0 deletions docs/references/nodejs/available-methods.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ title: Node.js Available Methods
description: Learn how to use the Clerk Node.js SDK to interact with the Clerk API.
---

> [!CAUTION]
> On January 8, 2025, the Node SDK will no longer be available. [Upgrade to the Express SDK.](/docs/upgrade-guides/node-to-express)
All resource operations are mounted as sub-APIs on the `clerkClient` object. You can find the full list of available operations in the [JavaScript Backend SDK](/docs/references/backend/overview) documentation. To access a resource, you must first instantiate a `clerkClient` instance.

## Instantiate a default `clerkClient` instance
Expand Down
3 changes: 3 additions & 0 deletions docs/references/nodejs/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ title: Clerk Node.js SDK
description: Learn how to integrate Node.js into your Clerk application.
---

> [!CAUTION]
> On January 8, 2025, the Node SDK will no longer be available. [Upgrade to the Express SDK.](/docs/upgrade-guides/node-to-express)
## Set up Clerk Node.js

<Steps>
Expand Down

0 comments on commit 841b084

Please sign in to comment.