zerthox / betterdiscord-types

Type definitions for BetterDiscord.

BetterDiscord Types

Typescript type definitions for BetterDiscord.

Usage

npm install @types/betterdiscord@github:zerthox/betterdiscord-types

Note: When installing under a name not starting with @types, definitions for globals may not be included. Importing the module somewhere or using for example typeRoots can fix this.

import type { Patcher, Filters } from "betterdiscord";

Custom Data Type

A custom type for BetterDiscord's BdApi.Data interface may be supplied. This enables more specific typing for Data's functions.

When used from BdApi directly, Data needs to be casted:

import type { Data } from "betterdiscord";

const TypedData = BdApi.Data as Data<CustomDataType>;

When using a bound version of BdApi, the custom type can be supplied in the constructor:

const BoundBdApi = new BdApi<CustomDataType>("PluginName");

betterdiscord-types's Issues

`ModuleFilter` too many parameters?

https://github.com/BetterDiscord/BetterDiscord/blob/b62deff1407c52bda5415a2d464de9566a78e4f4/renderer/src/modules/webpackmodules.js#L8-L13

https://github.com/DefinitelyTyped/DefinitelyTyped/blob/39359c8466846541b5b3298165ef79c509f0cd09/types/bandagedbd__bdapi/index.d.ts#L1273

addStyle and removeStyle expect 1 argument less than they should

Hi, I'm having an issue with the DOM.addStyle and DOM.removeStyle methods, for some reason they expect 1 argument less than they should?

src/index.tsx:15:37 - error TS2554: Expected 1 arguments, but got 2.
15     this.bdApi.DOM.addStyle('test', `random css`);
                                       ~~~~~~~~~~~~

src/index.tsx:20:32 - error TS2554: Expected 0 arguments, but got 1.
20     this.bdApi.DOM.removeStyle('test');

ContextMenu.patch callback cannot accept props argument

Patching a context menu like shown below results in an error, as the ContextMenuCallback type cannot have a props argument, even though I believe the props are passed to the patch callback.

BdApi.ContextMenu.patch("guild-context", (ret, props) => {
    console.log(props);
});

className is not callable

This expression is not callable.
  Type '{ default: (...args: ArgumentArray) => string; }' has no call signatures. ts(2349)

utils.d.ts(1, 1): Type originates at this import.
A namespace-style import cannot be called or constructed,
and will cause a failure at runtime.
Consider using a default import or import require here instead.

The definition type is incorrect.

// use
import classNames from "classnames";
// instead of
import * as classNames from "classnames";

Add types for Net

Add types for BetterDiscord's new (beta) Net API.

Allow supplying Data type

BdApi.Data is currently typed to be opaque to the user. The user could be allowed to optionally supply a type parameter to Data (and BdApi & BoundBdApi), which would be used to type accesses via save, load and delete.

Bug - Bound Patcher Loses Correct Typings

The Patcher methods on a bound instance of BdApi lose their proper typings, likely because the Bound type used to create the bound patcher doesn't retain the methods' generics.

With BdApi.Patcher.after:

With new BdApi("Caller").Patcher.after and the same arguments passed without the caller:

I've been playing around with trying to find some solutions, but the only thing that's worked so far is just redefining the patcher without the caller argument in its methods. There might be a more creative solution, but I haven't been able to find one.