nostr-hooks/dist/types/index.d.ts

React hooks for developing Nostr clients

import { NDKConstructorParams, NDKEvent, NDKFilter, NDKNip07Signer, NDKNip46Signer, NDKPrivateKeySigner, NDKSigner, NDKSubscription, NDKSubscriptionOptions } from '@nostr-dev-kit/ndk';
export type Subscriptions = Record<string, {
    subscription: NDKSubscription;
    events: NDKEvent[];
    eose: boolean;
    hasMore: boolean;
    listenersCount: number;
}>;
export type CreateSubscriptionParams = {
    subId: string;
    filters: NDKFilter[];
    opts?: NDKSubscriptionOptions;
    relayUrls?: string[];
    autoStart?: boolean;
    onEvent?: (event: NDKEvent) => void;
    replaceOlderReplaceableEvents?: boolean;
};
export type CreateSubscription = (params: CreateSubscriptionParams) => NDKSubscription | null;
export type RemoveSubscription = (subId: string | undefined) => void;
export type InitNdk = (constructorParams?: NDKConstructorParams, update?: boolean) => void;
export type SetSigner = (signer: NDKSigner | undefined) => void;
export type LoginData = {
    privateKey: string | undefined;
    loginMethod: 'Extension' | 'Remote' | 'PrivateKey' | undefined;
    nip46Address: string | undefined;
};
export type LoginWithExtension = (options?: {
    onError?: (err: any) => void;
    onSuccess?: (signer: NDKNip07Signer) => void;
}) => void;
export type LoginWithRemoteSigner = (options?: {
    nip46Address?: string | undefined;
    onError?: (err: unknown) => void;
    onSuccess?: (signer: NDKNip46Signer) => void;
}) => void;
export type LoginWithPrivateKey = (options?: {
    privateKey?: string | undefined;
    onError?: (err: unknown) => void;
    onSuccess?: (signer: NDKPrivateKeySigner) => void;
}) => void;