@towns-protocol/react-sdk/dist/types/useJoinSpace.d.ts

React Hooks for Towns Protocol SDK

import type { Spaces } from '@towns-protocol/sdk';
import { type ActionConfig } from './internals/useAction';
/**
 * Hook to join a space.
 * @param config - Configuration options for the action.
 * @returns The joinSpace action and the status of the action.
 */
export declare const useJoinSpace: (config?: ActionConfig<Spaces["joinSpace"]>) => {
    data: void | undefined;
    error: Error | undefined;
    isPending: boolean;
    isSuccess: boolean;
    isError: boolean;
    /**
     * Action to join a space.
     * @param spaceId - The id of the space to join.
     * @param signer - The signer to use to join the space.
     * @param opts - Options for the join action.
     */
    joinSpace: (spaceId: string, signer: import("ethers").Signer, opts?: {
        skipMintMembership?: boolean;
    } | undefined) => Promise<void>;
};
//# sourceMappingURL=useJoinSpace.d.ts.map