# Function: useInviteLink()

```ts
function useInviteLink(): object;
```

Defined in: [packages/react/src/use-invite-link.ts:38](https://github.com/leifriksheim/minca/blob/main/react/src/use-invite-link.ts#L38)

The invite this page was opened with, if any, and what it is for: the
space's name, the role it gives, who sent it. `dismiss` takes it out of the
address bar, once joined or declined, so a reload doesn't offer it again.
`problem` says why an invite could not be read.

## Returns

`object`

### dismiss

```ts
dismiss: () => void;
```

#### Returns

`void`

### invite

```ts
invite: string | null;
```

### preview

```ts
preview: 
  | InvitePreview
  | null;
```

### problem

```ts
problem: string | null;
```