Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace VulcanMeteorHooks

Index

Functions

Functions

Const useAuthenticateWithPassword

  • useAuthenticateWithPassword(options?: MutationHookOptions<{ authenticateWithPassword: AuthWithPasswordOutput }, ApolloVariables<AuthWithPasswordInput>, DefaultContext, ApolloCache<any>>): EnhancedMutationTuple<{ authenticateWithPassword: AuthWithPasswordOutput }, ApolloVariables<AuthWithPasswordInput>>

  • Parameters

    • Optional options: MutationHookOptions<{ authenticateWithPassword: AuthWithPasswordOutput }, ApolloVariables<AuthWithPasswordInput>, DefaultContext, ApolloCache<any>>

    Returns EnhancedMutationTuple<{ authenticateWithPassword: AuthWithPasswordOutput }, ApolloVariables<AuthWithPasswordInput>>

Const useCurrentUser

  • useCurrentUser(): { called: boolean; client: ApolloClient<any>; currentUser: any; data: any; error?: ApolloError; loading: boolean; networkStatus: NetworkStatus; observable: ObservableQuery<any, OperationVariables>; previousData?: any; variables: undefined | OperationVariables; fetchMore: any; refetch: any; reobserve: any; startPolling: any; stopPolling: any; subscribeToMore: any; updateQuery: any }

  • Returns { called: boolean; client: ApolloClient<any>; currentUser: any; data: any; error?: ApolloError; loading: boolean; networkStatus: NetworkStatus; observable: ObservableQuery<any, OperationVariables>; previousData?: any; variables: undefined | OperationVariables; fetchMore: any; refetch: any; reobserve: any; startPolling: any; stopPolling: any; subscribeToMore: any; updateQuery: any }

    • called: boolean
    • client: ApolloClient<any>
    • currentUser: any
    • data: any
    • Optional error?: ApolloError
    • loading: boolean
    • networkStatus: NetworkStatus
    • observable: ObservableQuery<any, OperationVariables>
    • Optional previousData?: any
    • variables: undefined | OperationVariables
    • fetchMore: function
      • fetchMore<TFetchData, TFetchVars>(fetchMoreOptions: FetchMoreQueryOptions<TFetchVars, TFetchData> & { updateQuery?: any }): Promise<ApolloQueryResult<TFetchData>>

      • Type parameters

        • TFetchData = any

        • TFetchVars = OperationVariables

        Parameters

        • fetchMoreOptions: FetchMoreQueryOptions<TFetchVars, TFetchData> & { updateQuery?: any }

        Returns Promise<ApolloQueryResult<TFetchData>>

    • refetch: function
      • refetch(variables?: Partial<OperationVariables>): Promise<ApolloQueryResult<any>>

      • Parameters

        • Optional variables: Partial<OperationVariables>

        Returns Promise<ApolloQueryResult<any>>

    • reobserve: function
      • reobserve(newOptions?: Partial<WatchQueryOptions<OperationVariables, any>>, newNetworkStatus?: NetworkStatus): Promise<ApolloQueryResult<any>>

      • Parameters

        • Optional newOptions: Partial<WatchQueryOptions<OperationVariables, any>>
        • Optional newNetworkStatus: NetworkStatus

        Returns Promise<ApolloQueryResult<any>>

    • startPolling: function
      • startPolling(pollInterval: number): void

      • Parameters

        • pollInterval: number

        Returns void

    • stopPolling: function
      • stopPolling(): void

      • Returns void

    • subscribeToMore: function
      • subscribeToMore<TSubscriptionData, TSubscriptionVariables>(options: SubscribeToMoreOptions<any, TSubscriptionVariables, TSubscriptionData>): () => void

      • Type parameters

        • TSubscriptionData = any

        • TSubscriptionVariables = OperationVariables

        Parameters

        • options: SubscribeToMoreOptions<any, TSubscriptionVariables, TSubscriptionData>

        Returns () => void

          • (): void

          • Returns void

    • updateQuery: function
      • updateQuery<TVars>(mapFn: (previousQueryResult: any, options: Pick<WatchQueryOptions<TVars, any>, "variables">) => any): void

      • Type parameters

        • TVars = OperationVariables

        Parameters

        • mapFn: (previousQueryResult: any, options: Pick<WatchQueryOptions<TVars, any>, "variables">) => any
            • (previousQueryResult: any, options: Pick<WatchQueryOptions<TVars, any>, "variables">): any

            • Parameters

              • previousQueryResult: any
              • options: Pick<WatchQueryOptions<TVars, any>, "variables">

              Returns any

        Returns void

Const useLogout

  • useLogout(options?: MutationHookOptions<{ logout: LogoutOutput }, ApolloVariables<LogoutInput>, DefaultContext, ApolloCache<any>>): EnhancedMutationTuple<{ logout: LogoutOutput }, ApolloVariables<LogoutInput>>

  • Parameters

    • Optional options: MutationHookOptions<{ logout: LogoutOutput }, ApolloVariables<LogoutInput>, DefaultContext, ApolloCache<any>>

    Returns EnhancedMutationTuple<{ logout: LogoutOutput }, ApolloVariables<LogoutInput>>

Const useResetPassword

  • useResetPassword(options?: MutationHookOptions<{ resetPassword: ResetPasswordOutput }, ApolloVariables<ResetPasswordInput>, DefaultContext, ApolloCache<any>>): EnhancedMutationTuple<{ resetPassword: ResetPasswordOutput }, ApolloVariables<ResetPasswordInput>>

  • Change the password using a "forgotten password" token sent by mail

    Parameters

    • Optional options: MutationHookOptions<{ resetPassword: ResetPasswordOutput }, ApolloVariables<ResetPasswordInput>, DefaultContext, ApolloCache<any>>

    Returns EnhancedMutationTuple<{ resetPassword: ResetPasswordOutput }, ApolloVariables<ResetPasswordInput>>

Const useSendResetPasswordEmail

  • useSendResetPasswordEmail(options?: MutationHookOptions<{ sendResetPasswordEmail: boolean }, ApolloVariables<SendResetPasswordEmailInput>, DefaultContext, ApolloCache<any>>): EnhancedMutationTuple<{ sendResetPasswordEmail: boolean }, ApolloVariables<SendResetPasswordEmailInput>>

  • Trigger the reset password email

    Parameters

    • Optional options: MutationHookOptions<{ sendResetPasswordEmail: boolean }, ApolloVariables<SendResetPasswordEmailInput>, DefaultContext, ApolloCache<any>>

    Returns EnhancedMutationTuple<{ sendResetPasswordEmail: boolean }, ApolloVariables<SendResetPasswordEmailInput>>

Const useSendVerificationEmail

  • useSendVerificationEmail(options?: MutationHookOptions<{ sendVerificationEmail: boolean }, ApolloVariables<SendVerificationEmailInput>, DefaultContext, ApolloCache<any>>): EnhancedMutationTuple<{ sendVerificationEmail: boolean }, ApolloVariables<SendVerificationEmailInput>>

  • Send again the verification email if necessary

    Parameters

    • Optional options: MutationHookOptions<{ sendVerificationEmail: boolean }, ApolloVariables<SendVerificationEmailInput>, DefaultContext, ApolloCache<any>>

    Returns EnhancedMutationTuple<{ sendVerificationEmail: boolean }, ApolloVariables<SendVerificationEmailInput>>

Const useSetPassword

  • useSetPassword(options?: MutationHookOptions<{ setPassword: SetPasswordOutput }, ApolloVariables<SetPasswordInput>, DefaultContext, ApolloCache<any>>): EnhancedMutationTuple<{ setPassword: SetPasswordOutput }, ApolloVariables<SetPasswordInput>>

  • Update the password (for an authenticated user)

    Parameters

    • Optional options: MutationHookOptions<{ setPassword: SetPasswordOutput }, ApolloVariables<SetPasswordInput>, DefaultContext, ApolloCache<any>>

    Returns EnhancedMutationTuple<{ setPassword: SetPasswordOutput }, ApolloVariables<SetPasswordInput>>

Const useSignup

  • useSignup(options?: MutationHookOptions<{ signup: SignupOutput }, ApolloVariables<SignupInput>, DefaultContext, ApolloCache<any>>): EnhancedMutationTuple<{ signup: SignupOutput }, ApolloVariables<SignupInput>>

  • Parameters

    • Optional options: MutationHookOptions<{ signup: SignupOutput }, ApolloVariables<SignupInput>, DefaultContext, ApolloCache<any>>

    Returns EnhancedMutationTuple<{ signup: SignupOutput }, ApolloVariables<SignupInput>>

Const verifyEmail

  • verifyEmail(options?: MutationHookOptions<{ verifyEmail: VerifyEmailOutput }, ApolloVariables<VerifyEmailInput>, DefaultContext, ApolloCache<any>>): EnhancedMutationTuple<{ verifyEmail: VerifyEmailOutput }, ApolloVariables<VerifyEmailInput>>

  • Parameters

    • Optional options: MutationHookOptions<{ verifyEmail: VerifyEmailOutput }, ApolloVariables<VerifyEmailInput>, DefaultContext, ApolloCache<any>>

    Returns EnhancedMutationTuple<{ verifyEmail: VerifyEmailOutput }, ApolloVariables<VerifyEmailInput>>

Generated using TypeDoc