Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@clerk/types

clerk3.4mMIT4.84.1TypeScript support: included

Typings for Clerk libraries.

clerk, react, auth, authentication, passwordless, session, jwt, types

readme

<picture> <source media="(prefers-color-scheme: dark)" srcset="https://images.clerk.com/static/logo-dark-mode-400x400.png"> </picture>

@clerk/types

Getting Started

This package provides the TypeScript type declarations for Clerk's SDKs.

[!NOTE] Clerk's SDKs automatically include their own type definitions so typically it's not necessary to install @clerk/types separately.

Installation

npm install @clerk/types --save-dev

Usage

Import types from @clerk/types like so:

import type { OAuthStrategy } from '@clerk/types';

export type OAuthProps = {
  oAuthOptions: OAuthStrategy[];
  error?: string;
  setError?: React.Dispatch<React.SetStateAction<string | undefined>>;
};

You can also override Clerk interfaces with custom types.

Support

You can get in touch with us in any of the following ways:

Contributing

We're open to all community contributions! If you'd like to contribute in any way, please read our contribution guidelines and code of conduct.

Security

@clerk/types follows good practices of security, but 100% security cannot be assured.

@clerk/types is provided "as is" without any warranty. Use at your own risk.

For more information and to report security issues, please refer to our security documentation.

License

This project is licensed under the MIT license.

See LICENSE for more information.