# Bans

### Check if a user is banned

```javascript
ksoft.bans.check(user);
ksoft.bans.check(users); // Array<user>
```

{% tabs %}
{% tab title="Usage" %}

| Parameter | Type                                        |
| --------- | ------------------------------------------- |
| **user**  | **String (Snowflake) or Array\<Snowflake>** |

{% hint style="success" %}
**Success:** Boolean (if only one user)
{% endhint %}

{% hint style="success" %}
**Success:** Array\<Snowflake> (if array, only of banned users)
{% endhint %}
{% endtab %}

{% tab title="Example" %}

```javascript
ksoft.bans.check('102102717165506560');
ksoft.bans.check(['102102717165506560', '356826975815598080']);
```

{% endtab %}
{% endtabs %}

### Get information about a ban

```javascript
ksoft.bans.info(user);
ksoft.bans.info(users); // Array<user>
```

{% tabs %}
{% tab title="Usage" %}

| Parameter | Type                                        |
| --------- | ------------------------------------------- |
| **user**  | **String (Snowflake) or Array\<Snowflake>** |

{% hint style="success" %}
**Success:** Ban (if one user)
{% endhint %}

{% hint style="success" %}
**Success:** Array\<Ban> (if multiple users, only of banned users)
{% endhint %}

{% hint style="danger" %}
**Not Found:** null (if one user)
{% endhint %}
{% endtab %}

{% tab title="Example" %}

```javascript
ksoft.bans.info('102102717165506560');
ksoft.bans.info(['102102717165506560', '356826975815598080']);
```

{% endtab %}
{% endtabs %}

### Report a user

```javascript
ksoft.bans.add(ban);
```

{% tabs %}
{% tab title="Usage" %}

| Parameter | Type    |
| --------- | ------- |
| **ban**   | **Ban** |

{% hint style="success" %}
**Success:** BanAPIResponse
{% endhint %}
{% endtab %}

{% tab title="Example" %}

```javascript
const ban = new Ban()
    .setUser('432129282710700033', 'Aero', '5703')
    // setUser also works by just passing a d.js user object
    .setModerator('102102717165506560')
    .setReason('Being the first bot to properly implement ksoft.js', 'https://git.aero.bot/aero/commit/a91c44b0');
    
ksoft.bans.add(ban);
```

{% endtab %}
{% endtabs %}