@clerk/nextjs/dist/types/server/buildClerkProps.d.ts

Clerk SDK for NextJS

import type { AuthObject, Organization, Session, User } from '@clerk/backend';
import type { RequestLike } from './types';
type BuildClerkPropsInitState = {
    user?: User | null;
    session?: Session | null;
    organization?: Organization | null;
};
type BuildClerkProps = (req: RequestLike, authState?: BuildClerkPropsInitState) => Record<string, unknown>;
/**
 * Clerk uses `buildClerkProps` to inform the client-side helpers of the authentication state of the user. This function is used SSR in the `getServerSideProps` function of your Next.js application.
 *
 * @example
 * **Basic usage**
 *
 * ```tsx
 * // pages/myServerSidePage.tsx
 *
 * import { getAuth, buildClerkProps } from '@clerk/nextjs/server'
 * import { GetServerSideProps } from 'next'
 *
 * export const getServerSideProps: GetServerSideProps = async (ctx) => {
 *  const { userId } = getAuth(ctx.req)
 *
 *  if (!userId) {
 *    // handle user is not signed in.
 *  }
 *
 *  // Load any data your application needs for the page using the userId
 *  return { props: { ...buildClerkProps(ctx.req) } }
 * }
 * ```
 *
 * @example
 * **Usage with `clerkClient`**
 *
 * The `clerkClient` allows you to access the Clerk API. You can use this to retrieve or update data.
 *
 * ```tsx
 * // pages/api/example.ts
 *
 * import { getAuth, buildClerkProps, clerkClient } from '@clerk/nextjs/server'
 * import { GetServerSideProps } from 'next'
 *
 * export const getServerSideProps: GetServerSideProps = async (ctx) => {
 *  const { userId } = getAuth(ctx.req)
 *
 *  const user = userId ? await clerkClient().users.getUser(userId) : undefined
 *
 *  return { props: { ...buildClerkProps(ctx.req, { user }) } }
 * }
 * ```
 */
export declare const buildClerkProps: BuildClerkProps;
export declare function getDynamicAuthData(req: RequestLike, initialState?: {}): AuthObject;
export {};
//# sourceMappingURL=buildClerkProps.d.ts.map