iceshrimp/packages/iceshrimp-js/test-d/api.ts

import { expectType } from "tsd";
import * as Misskey from "../src";

describe("API", () => {
	test("success", async () => {
		const cli = new Misskey.api.APIClient({
			origin: "https://iceshrimp.test",
			credential: "TOKEN",
		});
		const res = await cli.request("meta", { detail: true });
		expectType<Misskey.entities.DetailedInstanceMetadata>(res);
	});

	test("conditional respose type (meta)", async () => {
		const cli = new Misskey.api.APIClient({
			origin: "https://iceshrimp.test",
			credential: "TOKEN",
		});

		const res = await cli.request("meta", { detail: true });
		expectType<Misskey.entities.DetailedInstanceMetadata>(res);

		const res2 = await cli.request("meta", { detail: false });
		expectType<Misskey.entities.LiteInstanceMetadata>(res2);

		const res3 = await cli.request("meta", {});
		expectType<Misskey.entities.LiteInstanceMetadata>(res3);

		const res4 = await cli.request("meta", { detail: true as boolean });
		expectType<
			| Misskey.entities.LiteInstanceMetadata
			| Misskey.entities.DetailedInstanceMetadata
		>(res4);
	});

	test("conditional respose type (users/show)", async () => {
		const cli = new Misskey.api.APIClient({
			origin: "https://iceshrimp.test",
			credential: "TOKEN",
		});

		const res = await cli.request("users/show", { userId: "xxxxxxxx" });
		expectType<Misskey.entities.UserDetailed>(res);

		const res2 = await cli.request("users/show", { userIds: ["xxxxxxxx"] });
		expectType<Misskey.entities.UserDetailed[]>(res2);
	});
});