Skip to content
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

Add deprecation notice to Node SDK #1652

Merged
merged 3 commits into from
Oct 24, 2024
Merged

Add deprecation notice to Node SDK #1652

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
65f0592
docs(sdk-node): Add deprecation notice
wobsoriano Oct 24, 2024
d2cbb20
update callouts
alexisintech Oct 24, 2024
34a61b5
add todo
alexisintech Oct 24, 2024
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
9 changes: 6 additions & 3 deletions docs/backend-requests/handling/nodejs.mdx
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
Loading