# EventGateContext

`interface` in `gateway` · v0.1.0-next.3

<https://docs.seedcord.org/packages/gateway/0.1.0-next.3/interfaces/event-gate-context>

The event arm. It extends [`GuildPermissionsContext`](/packages/core/0.1.0-next.5/interfaces/guild-permissions-context) with the event payload and the djs objects derived from it. `Names` is the event(s) the gate supports, inferred from the `ctx` annotation, so a gate that reads one event's `payload` is rejected on a handler for a different event. The default supports every event.

```ts
interface EventGateContext<
    Names extends ValidNonInteractionKeys = ValidNonInteractionKeys
> extends GuildPermissionsContext
```

## Examples

```ts
import { Events } from 'discord.js';

// gate keyed to one event, so payload is typed to that event's args tuple
const OnMessage = defineGate('msg', (ctx: EventGateContext<Events.MessageCreate>) => {
    void ctx.payload; // [Message]
});
```

## Properties

### core

```ts
readonly core: Core
```

The running framework, with the gateway's bot and bus.

### eventName

```ts
readonly eventName: Names
```

The event being handled.

### guild

```ts
readonly guild: Guild | null
```

The guild derived from the payload, or null.

### kind

```ts
readonly kind: 'event'
```

The literal `'event'`, narrow on it before reading `payload`.

### member

```ts
readonly member: GuildMember | null
```

The acting member derived from the payload, or null.

### payload

```ts
readonly payload: ClientEvents[Names]
```

The event's arguments, typed to that event's args tuple.

### user

```ts
readonly user: User | null
```

The acting user derived from the payload, or null when the event carries none.