@lens-protocol/react/dist/declarations/src/publication/useHidePublication.d.ts

Interacting with the Lens Protocol API using React.

import { AnyPublication } from '@lens-protocol/api-bindings';
import { UseDeferredTask } from "../helpers/tasks.js";
export type UseHidePublicationArgs = {
    publication: AnyPublication;
};
/**
 * Hide a publication posted by the authenticated profile to prevent other profiles from seeing it.
 *
 * You MUST be authenticated via {@link useLogin} to use this hook.
 *
 * @example
 * ```tsx
 * import { useHidePublication, AnyPublication } from '@lens-protocol/react';
 *
 * function HidePublication({ publication }: { publication: AnyPublication }) {
 *   const { execute: hide, loading } = useHidePublication();
 *
 *   if (publication.isHidden) {
 *    return <span>Publication is hidden</span>;
 *   }
 *
 *   return (
 *     <button onClick={() => hide({ publication })} disabled={loading}>
 *       Hide publication
 *     </button>
 *   );
 * }
 * ```
 *
 * @category Publications
 * @group Hooks
 */
export declare function useHidePublication(): UseDeferredTask<void, never, UseHidePublicationArgs>;