@clerk/types

Changelog · Report a Bug · Request a Feature · Ask a Question

Overview

This package provides the TypeScript type declarations for Clerk libraries.

Getting Started

It is worth noting that Clerk packages automatically include their type declarations when installed so adding this package manually is not typically necessary.

Installation

npm install --save-dev @clerk/types

Build

npm run build

To build types in watch mode, run the following:

npm run dev

Usage

Example implementation:

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

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

For further details and examples, please refer to our Documentation.

Support

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

• Join our official community Discord server
• Create a GitHub Discussion
• Contact options listed on our Support page

Contributing

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

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.