Time to add the new API docs

docs/api/_category_.json

@@ -0,0 +1,8 @@
+{
+  "label": "Api",
+  "position": 3,
+  "link": {
+    "type": "generated-index",
+    "description": "Here you can find our api docs."
+  }
+}

docs/api/index.md

@@ -0,0 +1,12 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index)
+
+## API Reference
+
+## Packages
+
+|  Package | Description |
+|  --- | --- |
+|  [valkyrie-js](./valkyrie-js) |  |
+

docs/api/info.md

@@ -0,0 +1,7 @@
+---
+title: info
+---
+
+# About this section
+
+In this section of the documentation you will find the docs for the Valkyriecoms api which you can use by following the insturction of the [toastielab page](https://toastielab.dev/Valkyriecoms/-/packages/npm/valkyrie-js/0.0.24)

docs/api/valkyrie-js.acct.md

@@ -0,0 +1,14 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [Acct](./valkyrie-js.acct)
+
+## Acct type
+
+**Signature:**
+
+```typescript
+export declare type Acct = {
+	username: string;
+	host: string | null;
+};
+```

docs/api/valkyrie-js.api.apiclient._constructor_.md

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [api](./valkyrie-js.api) &gt; [APIClient](./valkyrie-js.api.apiclient) &gt; [(constructor)](./valkyrie-js.api.apiclient._constructor_)
+
+## api.APIClient.(constructor)
+
+Constructs a new instance of the `APIClient` class
+
+**Signature:**
+
+```typescript
+constructor(opts: {
+		origin: APIClient["origin"];
+		credential?: APIClient["credential"];
+		fetch?: APIClient["fetch"] | null | undefined;
+	});
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  opts | { origin: [APIClient](./valkyrie-js.api.apiclient)<!-- -->\["origin"\]; credential?: [APIClient](./valkyrie-js.api.apiclient)<!-- -->\["credential"\]; fetch?: [APIClient](./valkyrie-js.api.apiclient)<!-- -->\["fetch"\] \| null \| undefined; } |  |
+

docs/api/valkyrie-js.api.apiclient.credential.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [api](./valkyrie-js.api) &gt; [APIClient](./valkyrie-js.api.apiclient) &gt; [credential](./valkyrie-js.api.apiclient.credential)
+
+## api.APIClient.credential property
+
+**Signature:**
+
+```typescript
+credential: string | null | undefined;
+```

docs/api/valkyrie-js.api.apiclient.fetch.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [api](./valkyrie-js.api) &gt; [APIClient](./valkyrie-js.api.apiclient) &gt; [fetch](./valkyrie-js.api.apiclient.fetch)
+
+## api.APIClient.fetch property
+
+**Signature:**
+
+```typescript
+fetch: FetchLike;
+```

docs/api/valkyrie-js.api.apiclient.md

@@ -0,0 +1,32 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [api](./valkyrie-js.api) &gt; [APIClient](./valkyrie-js.api.apiclient)
+
+## api.APIClient class
+
+**Signature:**
+
+```typescript
+export declare class APIClient 
+```
+
+## Constructors
+
+|  Constructor | Modifiers | Description |
+|  --- | --- | --- |
+|  [(constructor)(opts)](./valkyrie-js.api.apiclient._constructor_) |  | Constructs a new instance of the <code>APIClient</code> class |
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [credential](./valkyrie-js.api.apiclient.credential) |  | string \| null \| undefined |  |
+|  [fetch](./valkyrie-js.api.apiclient.fetch) |  | [FetchLike](./valkyrie-js.api.fetchlike) |  |
+|  [origin](./valkyrie-js.api.apiclient.origin) |  | string |  |
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [request(endpoint, params, credential)](./valkyrie-js.api.apiclient.request) |  |  |
+

docs/api/valkyrie-js.api.apiclient.origin.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [api](./valkyrie-js.api) &gt; [APIClient](./valkyrie-js.api.apiclient) &gt; [origin](./valkyrie-js.api.apiclient.origin)
+
+## api.APIClient.origin property
+
+**Signature:**
+
+```typescript
+origin: string;
+```

docs/api/valkyrie-js.api.apiclient.request.md

@@ -0,0 +1,57 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [api](./valkyrie-js.api) &gt; [APIClient](./valkyrie-js.api.apiclient) &gt; [request](./valkyrie-js.api.apiclient.request)
+
+## api.APIClient.request() method
+
+**Signature:**
+
+```typescript
+request<E extends keyof Endpoints, P extends Endpoints[E]["req"]>(
+		endpoint: E,
+		params?: P,
+		credential?: string | null | undefined,
+	): Promise<
+		Endpoints[E]["res"] extends {
+			$switch: {
+				$cases: [any, any][];
+				$default: any;
+			};
+		}
+			? IsCaseMatched<E, P, 0> extends true
+				? GetCaseResult<E, P, 0>
+				: IsCaseMatched<E, P, 1> extends true
+				? GetCaseResult<E, P, 1>
+				: IsCaseMatched<E, P, 2> extends true
+				? GetCaseResult<E, P, 2>
+				: IsCaseMatched<E, P, 3> extends true
+				? GetCaseResult<E, P, 3>
+				: IsCaseMatched<E, P, 4> extends true
+				? GetCaseResult<E, P, 4>
+				: IsCaseMatched<E, P, 5> extends true
+				? GetCaseResult<E, P, 5>
+				: IsCaseMatched<E, P, 6> extends true
+				? GetCaseResult<E, P, 6>
+				: IsCaseMatched<E, P, 7> extends true
+				? GetCaseResult<E, P, 7>
+				: IsCaseMatched<E, P, 8> extends true
+				? GetCaseResult<E, P, 8>
+				: IsCaseMatched<E, P, 9> extends true
+				? GetCaseResult<E, P, 9>
+				: Endpoints[E]["res"]["$switch"]["$default"]
+			: Endpoints[E]["res"]
+	>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  endpoint | E |  |
+|  params | P | _(Optional)_ |
+|  credential | string \| null \| undefined | _(Optional)_ |
+
+**Returns:**
+
+Promise&lt; [Endpoints](./valkyrie-js.endpoints)<!-- -->\[E\]\["res"\] extends { $switch: { $cases: \[any, any\]\[\]; $default: any; }; } ? IsCaseMatched&lt;E, P, 0&gt; extends true ? GetCaseResult&lt;E, P, 0&gt; : IsCaseMatched&lt;E, P, 1&gt; extends true ? GetCaseResult&lt;E, P, 1&gt; : IsCaseMatched&lt;E, P, 2&gt; extends true ? GetCaseResult&lt;E, P, 2&gt; : IsCaseMatched&lt;E, P, 3&gt; extends true ? GetCaseResult&lt;E, P, 3&gt; : IsCaseMatched&lt;E, P, 4&gt; extends true ? GetCaseResult&lt;E, P, 4&gt; : IsCaseMatched&lt;E, P, 5&gt; extends true ? GetCaseResult&lt;E, P, 5&gt; : IsCaseMatched&lt;E, P, 6&gt; extends true ? GetCaseResult&lt;E, P, 6&gt; : IsCaseMatched&lt;E, P, 7&gt; extends true ? GetCaseResult&lt;E, P, 7&gt; : IsCaseMatched&lt;E, P, 8&gt; extends true ? GetCaseResult&lt;E, P, 8&gt; : IsCaseMatched&lt;E, P, 9&gt; extends true ? GetCaseResult&lt;E, P, 9&gt; : [Endpoints](./valkyrie-js.endpoints)<!-- -->\[E\]\["res"\]\["$switch"\]\["$default"\] : [Endpoints](./valkyrie-js.endpoints)<!-- -->\[E\]\["res"\] &gt;
+

docs/api/valkyrie-js.api.apierror.md

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [api](./valkyrie-js.api) &gt; [APIError](./valkyrie-js.api.apierror)
+
+## api.APIError type
+
+**Signature:**
+
+```typescript
+export declare type APIError = {
+	id: string;
+	code: string;
+	message: string;
+	kind: "client" | "server";
+	info: Record<string, any>;
+};
+```

docs/api/valkyrie-js.api.fetchlike.md

@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [api](./valkyrie-js.api) &gt; [FetchLike](./valkyrie-js.api.fetchlike)
+
+## api.FetchLike type
+
+**Signature:**
+
+```typescript
+export declare type FetchLike = (
+	input: string,
+	init?: {
+		method?: string;
+		body?: string;
+		credentials?: RequestCredentials;
+		cache?: RequestCache;
+	},
+) => Promise<{
+	status: number;
+	json(): Promise<any>;
+}>;
+```

docs/api/valkyrie-js.api.isapierror.md

@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [api](./valkyrie-js.api) &gt; [isAPIError](./valkyrie-js.api.isapierror)
+
+## api.isAPIError() function
+
+**Signature:**
+
+```typescript
+export declare function isAPIError(reason: any): reason is APIError;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  reason | any |  |
+
+**Returns:**
+
+reason is [APIError](./valkyrie-js.api.apierror)
+

docs/api/valkyrie-js.api.md

@@ -0,0 +1,25 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [api](./valkyrie-js.api)
+
+## api namespace
+
+## Classes
+
+|  Class | Description |
+|  --- | --- |
+|  [APIClient](./valkyrie-js.api.apiclient) |  |
+
+## Functions
+
+|  Function | Description |
+|  --- | --- |
+|  [isAPIError(reason)](./valkyrie-js.api.isapierror) |  |
+
+## Type Aliases
+
+|  Type Alias | Description |
+|  --- | --- |
+|  [APIError](./valkyrie-js.api.apierror) |  |
+|  [FetchLike](./valkyrie-js.api.fetchlike) |  |
+

docs/api/valkyrie-js.channelconnection._constructor_.md

@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [ChannelConnection](./valkyrie-js.channelconnection) &gt; [(constructor)](./valkyrie-js.channelconnection._constructor_)
+
+## ChannelConnection.(constructor)
+
+Constructs a new instance of the `Connection` class
+
+**Signature:**
+
+```typescript
+constructor(stream: Stream, channel: string, name?: string);
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  stream | [Stream](./valkyrie-js.stream) |  |
+|  channel | string |  |
+|  name | string | _(Optional)_ |
+

docs/api/valkyrie-js.channelconnection.channel.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [ChannelConnection](./valkyrie-js.channelconnection) &gt; [channel](./valkyrie-js.channelconnection.channel)
+
+## ChannelConnection.channel property
+
+**Signature:**
+
+```typescript
+channel: string;
+```

docs/api/valkyrie-js.channelconnection.dispose.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [ChannelConnection](./valkyrie-js.channelconnection) &gt; [dispose](./valkyrie-js.channelconnection.dispose)
+
+## ChannelConnection.dispose() method
+
+**Signature:**
+
+```typescript
+abstract dispose(): void;
+```
+**Returns:**
+
+void
+

docs/api/valkyrie-js.channelconnection.id.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [ChannelConnection](./valkyrie-js.channelconnection) &gt; [id](./valkyrie-js.channelconnection.id)
+
+## ChannelConnection.id property
+
+**Signature:**
+
+```typescript
+abstract id: string;
+```

docs/api/valkyrie-js.channelconnection.incount.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [ChannelConnection](./valkyrie-js.channelconnection) &gt; [inCount](./valkyrie-js.channelconnection.incount)
+
+## ChannelConnection.inCount property
+
+**Signature:**
+
+```typescript
+inCount: number;
+```

docs/api/valkyrie-js.channelconnection.md

@@ -0,0 +1,39 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [ChannelConnection](./valkyrie-js.channelconnection)
+
+## ChannelConnection class
+
+**Signature:**
+
+```typescript
+export declare abstract class Connection<
+	Channel extends AnyOf<Channels> = any,
+> extends EventEmitter<Channel["events"]> 
+```
+**Extends:** EventEmitter&lt;Channel\["events"\]&gt;
+
+## Constructors
+
+|  Constructor | Modifiers | Description |
+|  --- | --- | --- |
+|  [(constructor)(stream, channel, name)](./valkyrie-js.channelconnection._constructor_) |  | Constructs a new instance of the <code>Connection</code> class |
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [channel](./valkyrie-js.channelconnection.channel) |  | string |  |
+|  [id](./valkyrie-js.channelconnection.id) | <code>abstract</code> | string |  |
+|  [inCount](./valkyrie-js.channelconnection.incount) |  | number |  |
+|  [name?](./valkyrie-js.channelconnection.name) |  | string | _(Optional)_ |
+|  [outCount](./valkyrie-js.channelconnection.outcount) |  | number |  |
+|  [stream](./valkyrie-js.channelconnection.stream) | <code>protected</code> | [Stream](./valkyrie-js.stream) |  |
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [dispose()](./valkyrie-js.channelconnection.dispose) | <code>abstract</code> |  |
+|  [send(type, body)](./valkyrie-js.channelconnection.send) |  |  |
+

docs/api/valkyrie-js.channelconnection.name.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [ChannelConnection](./valkyrie-js.channelconnection) &gt; [name](./valkyrie-js.channelconnection.name)
+
+## ChannelConnection.name property
+
+**Signature:**
+
+```typescript
+name?: string;
+```

docs/api/valkyrie-js.channelconnection.outcount.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [ChannelConnection](./valkyrie-js.channelconnection) &gt; [outCount](./valkyrie-js.channelconnection.outcount)
+
+## ChannelConnection.outCount property
+
+**Signature:**
+
+```typescript
+outCount: number;
+```

docs/api/valkyrie-js.channelconnection.send.md

@@ -0,0 +1,26 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [ChannelConnection](./valkyrie-js.channelconnection) &gt; [send](./valkyrie-js.channelconnection.send)
+
+## ChannelConnection.send() method
+
+**Signature:**
+
+```typescript
+send<T extends keyof Channel["receives"]>(
+		type: T,
+		body: Channel["receives"][T],
+	): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  type | T |  |
+|  body | Channel\["receives"\]\[T\] |  |
+
+**Returns:**
+
+void
+

docs/api/valkyrie-js.channelconnection.stream.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [ChannelConnection](./valkyrie-js.channelconnection) &gt; [stream](./valkyrie-js.channelconnection.stream)
+
+## ChannelConnection.stream property
+
+**Signature:**
+
+```typescript
+protected stream: Stream;
+```

docs/api/valkyrie-js.channels.md

@@ -0,0 +1,143 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [Channels](./valkyrie-js.channels)
+
+## Channels type
+
+**Signature:**
+
+```typescript
+export declare type Channels = {
+	main: {
+		params: null;
+		events: {
+			notification: (payload: Notification) => void;
+			mention: (payload: Note) => void;
+			reply: (payload: Note) => void;
+			renote: (payload: Note) => void;
+			follow: (payload: User) => void;
+			followed: (payload: User) => void;
+			unfollow: (payload: User) => void;
+			meUpdated: (payload: MeDetailed) => void;
+			pageEvent: (payload: PageEvent) => void;
+			urlUploadFinished: (payload: {
+				marker: string;
+				file: DriveFile;
+			}) => void;
+			readAllNotifications: () => void;
+			unreadNotification: (payload: Notification) => void;
+			unreadMention: (payload: Note["id"]) => void;
+			readAllUnreadMentions: () => void;
+			unreadSpecifiedNote: (payload: Note["id"]) => void;
+			readAllUnreadSpecifiedNotes: () => void;
+			readAllMessagingMessages: () => void;
+			messagingMessage: (payload: MessagingMessage) => void;
+			unreadMessagingMessage: (payload: MessagingMessage) => void;
+			readAllAntennas: () => void;
+			unreadAntenna: (payload: Antenna) => void;
+			readAllAnnouncements: () => void;
+			readAllChannels: () => void;
+			unreadChannel: (payload: Note["id"]) => void;
+			myTokenRegenerated: () => void;
+			reversiNoInvites: () => void;
+			reversiInvited: (payload: FIXME) => void;
+			signin: (payload: FIXME) => void;
+			registryUpdated: (payload: {
+				scope?: string[];
+				key: string;
+				value: any | null;
+			}) => void;
+			driveFileCreated: (payload: DriveFile) => void;
+			readAntenna: (payload: Antenna) => void;
+		};
+		receives: null;
+	};
+	homeTimeline: {
+		params: null;
+		events: {
+			note: (payload: Note) => void;
+		};
+		receives: null;
+	};
+	localTimeline: {
+		params: null;
+		events: {
+			note: (payload: Note) => void;
+		};
+		receives: null;
+	};
+	hybridTimeline: {
+		params: null;
+		events: {
+			note: (payload: Note) => void;
+		};
+		receives: null;
+	};
+	recommendedTimeline: {
+		params: null;
+		events: {
+			note: (payload: Note) => void;
+		};
+		receives: null;
+	};
+	globalTimeline: {
+		params: null;
+		events: {
+			note: (payload: Note) => void;
+		};
+		receives: null;
+	};
+	antenna: {
+		params: {
+			antennaId: Antenna["id"];
+		};
+		events: {
+			note: (payload: Note) => void;
+		};
+		receives: null;
+	};
+	messaging: {
+		params: {
+			otherparty?: User["id"] | null;
+			group?: UserGroup["id"] | null;
+		};
+		events: {
+			message: (payload: MessagingMessage) => void;
+			deleted: (payload: MessagingMessage["id"]) => void;
+			read: (payload: MessagingMessage["id"][]) => void;
+			typers: (payload: User[]) => void;
+		};
+		receives: {
+			read: {
+				id: MessagingMessage["id"];
+			};
+		};
+	};
+	serverStats: {
+		params: null;
+		events: {
+			stats: (payload: FIXME) => void;
+		};
+		receives: {
+			requestLog: {
+				id: string | number;
+				length: number;
+			};
+		};
+	};
+	queueStats: {
+		params: null;
+		events: {
+			stats: (payload: FIXME) => void;
+		};
+		receives: {
+			requestLog: {
+				id: string | number;
+				length: number;
+			};
+		};
+	};
+};
+```
+**References:** [Note](./valkyrie-js.entities.note)<!-- -->, [User](./valkyrie-js.entities.user)<!-- -->, [MeDetailed](./valkyrie-js.entities.medetailed)<!-- -->, [PageEvent](./valkyrie-js.entities.pageevent)<!-- -->, [DriveFile](./valkyrie-js.entities.drivefile)<!-- -->, [MessagingMessage](./valkyrie-js.entities.messagingmessage)<!-- -->, [Antenna](./valkyrie-js.entities.antenna)<!-- -->, [UserGroup](./valkyrie-js.entities.usergroup)
+

docs/api/valkyrie-js.entities.ad.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities) &gt; [Ad](./valkyrie-js.entities.ad)
+
+## entities.Ad type
+
+**Signature:**
+
+```typescript
+export declare type Ad = TODO;
+```

docs/api/valkyrie-js.entities.announcement.md

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities) &gt; [Announcement](./valkyrie-js.entities.announcement)
+
+## entities.Announcement type
+
+**Signature:**
+
+```typescript
+export declare type Announcement = {
+	id: ID;
+	createdAt: DateString;
+	updatedAt: DateString | null;
+	text: string;
+	title: string;
+	imageUrl: string | null;
+	isRead?: boolean;
+};
+```
+**References:** [ID](./valkyrie-js.entities.id)<!-- -->, [DateString](./valkyrie-js.entities.datestring)
+

docs/api/valkyrie-js.entities.antenna.md

@@ -0,0 +1,29 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities) &gt; [Antenna](./valkyrie-js.entities.antenna)
+
+## entities.Antenna type
+
+**Signature:**
+
+```typescript
+export declare type Antenna = {
+	id: ID;
+	createdAt: DateString;
+	name: string;
+	keywords: string[][];
+	excludeKeywords: string[][];
+	src: "home" | "all" | "users" | "list" | "group" | "instances";
+	userListId: ID | null;
+	userGroupId: ID | null;
+	users: string[];
+	instances: string[];
+	caseSensitive: boolean;
+	notify: boolean;
+	withReplies: boolean;
+	withFile: boolean;
+	hasUnreadNote: boolean;
+};
+```
+**References:** [ID](./valkyrie-js.entities.id)<!-- -->, [DateString](./valkyrie-js.entities.datestring)
+

docs/api/valkyrie-js.entities.app.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities) &gt; [App](./valkyrie-js.entities.app)
+
+## entities.App type
+
+**Signature:**
+
+```typescript
+export declare type App = TODO;
+```

docs/api/valkyrie-js.entities.authsession.md

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities) &gt; [AuthSession](./valkyrie-js.entities.authsession)
+
+## entities.AuthSession type
+
+**Signature:**
+
+```typescript
+export declare type AuthSession = {
+	id: ID;
+	app: App;
+	token: string;
+};
+```
+**References:** [ID](./valkyrie-js.entities.id)<!-- -->, [App](./valkyrie-js.entities.app)
+

docs/api/valkyrie-js.entities.blocking.md

@@ -0,0 +1,18 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities) &gt; [Blocking](./valkyrie-js.entities.blocking)
+
+## entities.Blocking type
+
+**Signature:**
+
+```typescript
+export declare type Blocking = {
+	id: ID;
+	createdAt: DateString;
+	blockeeId: User["id"];
+	blockee: UserDetailed;
+};
+```
+**References:** [ID](./valkyrie-js.entities.id)<!-- -->, [DateString](./valkyrie-js.entities.datestring)<!-- -->, [User](./valkyrie-js.entities.user)<!-- -->, [UserDetailed](./valkyrie-js.entities.userdetailed)
+

docs/api/valkyrie-js.entities.channel.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities) &gt; [Channel](./valkyrie-js.entities.channel)
+
+## entities.Channel type
+
+**Signature:**
+
+```typescript
+export declare type Channel = {
+	id: ID;
+};
+```
+**References:** [ID](./valkyrie-js.entities.id)
+

docs/api/valkyrie-js.entities.clip.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities) &gt; [Clip](./valkyrie-js.entities.clip)
+
+## entities.Clip type
+
+**Signature:**
+
+```typescript
+export declare type Clip = TODO;
+```

docs/api/valkyrie-js.entities.customemoji.md

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities) &gt; [CustomEmoji](./valkyrie-js.entities.customemoji)
+
+## entities.CustomEmoji type
+
+**Signature:**
+
+```typescript
+export declare type CustomEmoji = {
+	id: string;
+	name: string;
+	url: string;
+	category: string;
+	aliases: string[];
+};
+```

docs/api/valkyrie-js.entities.datestring.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities) &gt; [DateString](./valkyrie-js.entities.datestring)
+
+## entities.DateString type
+
+**Signature:**
+
+```typescript
+export declare type DateString = string;
+```

docs/api/valkyrie-js.entities.detailedinstancemetadata.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities) &gt; [DetailedInstanceMetadata](./valkyrie-js.entities.detailedinstancemetadata)
+
+## entities.DetailedInstanceMetadata type
+
+**Signature:**
+
+```typescript
+export declare type DetailedInstanceMetadata = LiteInstanceMetadata & {
+	features: Record<string, any>;
+};
+```
+**References:** [LiteInstanceMetadata](./valkyrie-js.entities.liteinstancemetadata)
+

docs/api/valkyrie-js.entities.drivefile.md

@@ -0,0 +1,26 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities) &gt; [DriveFile](./valkyrie-js.entities.drivefile)
+
+## entities.DriveFile type
+
+**Signature:**
+
+```typescript
+export declare type DriveFile = {
+	id: ID;
+	createdAt: DateString;
+	isSensitive: boolean;
+	name: string;
+	thumbnailUrl: string;
+	url: string;
+	type: string;
+	size: number;
+	md5: string;
+	blurhash: string;
+	comment: string | null;
+	properties: Record<string, any>;
+};
+```
+**References:** [ID](./valkyrie-js.entities.id)<!-- -->, [DateString](./valkyrie-js.entities.datestring)
+

docs/api/valkyrie-js.entities.drivefolder.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities) &gt; [DriveFolder](./valkyrie-js.entities.drivefolder)
+
+## entities.DriveFolder type
+
+**Signature:**
+
+```typescript
+export declare type DriveFolder = TODO;
+```

docs/api/valkyrie-js.entities.following.md

@@ -0,0 +1,18 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities) &gt; [Following](./valkyrie-js.entities.following)
+
+## entities.Following type
+
+**Signature:**
+
+```typescript
+export declare type Following = {
+	id: ID;
+	createdAt: DateString;
+	followerId: User["id"];
+	followeeId: User["id"];
+};
+```
+**References:** [ID](./valkyrie-js.entities.id)<!-- -->, [DateString](./valkyrie-js.entities.datestring)<!-- -->, [User](./valkyrie-js.entities.user)
+

docs/api/valkyrie-js.entities.followingfolloweepopulated.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities) &gt; [FollowingFolloweePopulated](./valkyrie-js.entities.followingfolloweepopulated)
+
+## entities.FollowingFolloweePopulated type
+
+**Signature:**
+
+```typescript
+export declare type FollowingFolloweePopulated = Following & {
+	followee: UserDetailed;
+};
+```
+**References:** [Following](./valkyrie-js.entities.following)<!-- -->, [UserDetailed](./valkyrie-js.entities.userdetailed)
+

docs/api/valkyrie-js.entities.followingfollowerpopulated.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities) &gt; [FollowingFollowerPopulated](./valkyrie-js.entities.followingfollowerpopulated)
+
+## entities.FollowingFollowerPopulated type
+
+**Signature:**
+
+```typescript
+export declare type FollowingFollowerPopulated = Following & {
+	follower: UserDetailed;
+};
+```
+**References:** [Following](./valkyrie-js.entities.following)<!-- -->, [UserDetailed](./valkyrie-js.entities.userdetailed)
+

docs/api/valkyrie-js.entities.followrequest.md

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities) &gt; [FollowRequest](./valkyrie-js.entities.followrequest)
+
+## entities.FollowRequest type
+
+**Signature:**
+
+```typescript
+export declare type FollowRequest = {
+	id: ID;
+	follower: User;
+	followee: User;
+};
+```
+**References:** [ID](./valkyrie-js.entities.id)<!-- -->, [User](./valkyrie-js.entities.user)
+

docs/api/valkyrie-js.entities.gallerypost.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities) &gt; [GalleryPost](./valkyrie-js.entities.gallerypost)
+
+## entities.GalleryPost type
+
+**Signature:**
+
+```typescript
+export declare type GalleryPost = TODO;
+```

docs/api/valkyrie-js.entities.id.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities) &gt; [ID](./valkyrie-js.entities.id)
+
+## entities.ID type
+
+**Signature:**
+
+```typescript
+export declare type ID = string;
+```

docs/api/valkyrie-js.entities.instance.md

@@ -0,0 +1,40 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities) &gt; [Instance](./valkyrie-js.entities.instance)
+
+## entities.Instance type
+
+**Signature:**
+
+```typescript
+export declare type Instance = {
+	id: ID;
+	caughtAt: DateString;
+	host: string;
+	usersCount: number;
+	notesCount: number;
+	followingCount: number;
+	followersCount: number;
+	driveUsage: number;
+	driveFiles: number;
+	latestRequestSentAt: DateString | null;
+	latestStatus: number | null;
+	latestRequestReceivedAt: DateString | null;
+	lastCommunicatedAt: DateString;
+	isNotResponding: boolean;
+	isSuspended: boolean;
+	softwareName: string | null;
+	softwareVersion: string | null;
+	openRegistrations: boolean | null;
+	name: string | null;
+	description: string | null;
+	maintainerName: string | null;
+	maintainerEmail: string | null;
+	iconUrl: string | null;
+	faviconUrl: string | null;
+	themeColor: string | null;
+	infoUpdatedAt: DateString | null;
+};
+```
+**References:** [ID](./valkyrie-js.entities.id)<!-- -->, [DateString](./valkyrie-js.entities.datestring)
+

docs/api/valkyrie-js.entities.instancemetadata.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities) &gt; [InstanceMetadata](./valkyrie-js.entities.instancemetadata)
+
+## entities.InstanceMetadata type
+
+**Signature:**
+
+```typescript
+export declare type InstanceMetadata =
+	| LiteInstanceMetadata
+	| DetailedInstanceMetadata;
+```
+**References:** [LiteInstanceMetadata](./valkyrie-js.entities.liteinstancemetadata)<!-- -->, [DetailedInstanceMetadata](./valkyrie-js.entities.detailedinstancemetadata)
+

docs/api/valkyrie-js.entities.liteinstancemetadata.md

@@ -0,0 +1,46 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./indexgt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities) &gt; [LiteInstanceMetadata](./valkyrie-js.entities.liteinstancemetadata)
+
+## entities.LiteInstanceMetadata type
+
+**Signature:**
+
+```typescript
+export declare type LiteInstanceMetadata = {
+	maintainerName: string | null;
+	maintainerEmail: string | null;
+	version: string;
+	name: string | null;
+	uri: string;
+	description: string | null;
+	tosUrl: string | null;
+	disableRegistration: boolean;
+	disableLocalTimeline: boolean;
+	disableRecommendedTimeline: boolean;
+	disableGlobalTimeline: boolean;
+	driveCapacityPerLocalUserMb: number;
+	driveCapacityPerRemoteUserMb: number;
+	enableHcaptcha: boolean;
+	hcaptchaSiteKey: string | null;
+	enableRecaptcha: boolean;
+	recaptchaSiteKey: string | null;
+	swPublickey: string | null;
+	maxNoteTextLength: number;
+	enableEmail: boolean;
+	enableTwitterIntegration: boolean;
+	enableGithubIntegration: boolean;
+	enableDiscordIntegration: boolean;
+	enableServiceWorker: boolean;
+	emojis: CustomEmoji[];
+	ads: {
+		id: ID;
+		ratio: number;
+		place: string;
+		url: string;
+		imageUrl: string;
+	}[];
+};
+```
+**References:** [CustomEmoji](./valkyrie-js.entities.customemoji)<!-- -->, [ID](./valkyrie-js.entities.id)
+

docs/api/valkyrie-js.entities.md

@@ -0,0 +1,51 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities)
+
+## entities namespace
+
+## Type Aliases
+
+|  Type Alias | Description |
+|  --- | --- |
+|  [Ad](./valkyrie-js.entities.ad) |  |
+|  [Announcement](./valkyrie-js.entities.announcement) |  |
+|  [Antenna](./valkyrie-js.entities.antenna) |  |
+|  [App](./valkyrie-js.entities.app) |  |
+|  [AuthSession](./valkyrie-js.entities.authsession) |  |
+|  [Blocking](./valkyrie-js.entities.blocking) |  |
+|  [Channel](./valkyrie-js.entities.channel) |  |
+|  [Clip](./valkyrie-js.entities.clip) |  |
+|  [CustomEmoji](./valkyrie-js.entities.customemoji) |  |
+|  [DateString](./valkyrie-js.entities.datestring) |  |
+|  [DetailedInstanceMetadata](./valkyrie-js.entities.detailedinstancemetadata) |  |
+|  [DriveFile](./valkyrie-js.entities.drivefile) |  |
+|  [DriveFolder](./valkyrie-js.entities.drivefolder) |  |
+|  [Following](./valkyrie-js.entities.following) |  |
+|  [FollowingFolloweePopulated](./valkyrie-js.entities.followingfolloweepopulated) |  |
+|  [FollowingFollowerPopulated](./valkyrie-js.entities.followingfollowerpopulated) |  |
+|  [FollowRequest](./valkyrie-js.entities.followrequest) |  |
+|  [GalleryPost](./valkyrie-js.entities.gallerypost) |  |
+|  [ID](./valkyrie-js.entities.id) |  |
+|  [Instance](./valkyrie-js.entities.instance) |  |
+|  [InstanceMetadata](./valkyrie-js.entities.instancemetadata) |  |
+|  [LiteInstanceMetadata](./valkyrie-js.entities.liteinstancemetadata) |  |
+|  [MeDetailed](./valkyrie-js.entities.medetailed) |  |
+|  [MessagingMessage](./valkyrie-js.entities.messagingmessage) |  |
+|  [Note](./valkyrie-js.entities.note) |  |
+|  [NoteFavorite](./valkyrie-js.entities.notefavorite) |  |
+|  [NoteReaction](./valkyrie-js.entities.notereaction) |  |
+|  [Notification](./valkyrie-js.entities.notification) |  |
+|  [OriginType](./valkyrie-js.entities.origintype) |  |
+|  [Page](./valkyrie-js.entities.page) |  |
+|  [PageEvent](./valkyrie-js.entities.pageevent) |  |
+|  [ServerInfo](./valkyrie-js.entities.serverinfo) |  |
+|  [Signin](./valkyrie-js.entities.signin) |  |
+|  [Stats](./valkyrie-js.entities.stats) |  |
+|  [User](./valkyrie-js.entities.user) |  |
+|  [UserDetailed](./valkyrie-js.entities.userdetailed) |  |
+|  [UserGroup](./valkyrie-js.entities.usergroup) |  |
+|  [UserList](./valkyrie-js.entities.userlist) |  |
+|  [UserLite](./valkyrie-js.entities.userlite) |  |
+|  [UserSorting](./valkyrie-js.entities.usersorting) |  |
+

docs/api/valkyrie-js.entities.medetailed.md

@@ -0,0 +1,40 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities) &gt; [MeDetailed](./valkyrie-js.entities.medetailed)
+
+## entities.MeDetailed type
+
+**Signature:**
+
+```typescript
+export declare type MeDetailed = UserDetailed & {
+	avatarId: DriveFile["id"];
+	bannerId: DriveFile["id"];
+	autoAcceptFollowed: boolean;
+	alwaysMarkNsfw: boolean;
+	carefulBot: boolean;
+	emailNotificationTypes: string[];
+	hasPendingReceivedFollowRequest: boolean;
+	hasUnreadAnnouncement: boolean;
+	hasUnreadAntenna: boolean;
+	hasUnreadChannel: boolean;
+	hasUnreadMentions: boolean;
+	hasUnreadMessagingMessage: boolean;
+	hasUnreadNotification: boolean;
+	hasUnreadSpecifiedNotes: boolean;
+	hideOnlineStatus: boolean;
+	injectFeaturedNote: boolean;
+	integrations: Record<string, any>;
+	isDeleted: boolean;
+	isExplorable: boolean;
+	mutedWords: string[][];
+	mutingNotificationTypes: string[];
+	noCrawle: boolean;
+	preventAiLearning: boolean;
+	receiveAnnouncementEmail: boolean;
+	usePasswordLessLogin: boolean;
+	[other: string]: any;
+};
+```
+**References:** [UserDetailed](./valkyrie-js.entities.userdetailed)<!-- -->, [DriveFile](./valkyrie-js.entities.drivefile)
+

docs/api/valkyrie-js.entities.messagingmessage.md

@@ -0,0 +1,27 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities) &gt; [MessagingMessage](./valkyrie-js.entities.messagingmessage)
+
+## entities.MessagingMessage type
+
+**Signature:**
+
+```typescript
+export declare type MessagingMessage = {
+	id: ID;
+	createdAt: DateString;
+	file: DriveFile | null;
+	fileId: DriveFile["id"] | null;
+	isRead: boolean;
+	reads: User["id"][];
+	text: string | null;
+	user: User;
+	userId: User["id"];
+	recipient?: User | null;
+	recipientId: User["id"] | null;
+	group?: UserGroup | null;
+	groupId: UserGroup["id"] | null;
+};
+```
+**References:** [ID](./valkyrie-js.entities.id)<!-- -->, [DateString](./valkyrie-js.entities.datestring)<!-- -->, [DriveFile](./valkyrie-js.entities.drivefile)<!-- -->, [User](./valkyrie-js.entities.user)<!-- -->, [UserGroup](./valkyrie-js.entities.usergroup)
+

docs/api/valkyrie-js.entities.note.md

@@ -0,0 +1,51 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities) &gt; [Note](./valkyrie-js.entities.note)
+
+## entities.Note type
+
+**Signature:**
+
+```typescript
+export declare type Note = {
+	id: ID;
+	createdAt: DateString;
+	text: string | null;
+	cw: string | null;
+	user: User;
+	userId: User["id"];
+	reply?: Note;
+	replyId: Note["id"];
+	renote?: Note;
+	renoteId: Note["id"];
+	files: DriveFile[];
+	fileIds: DriveFile["id"][];
+	visibility: "public" | "home" | "followers" | "specified";
+	visibleUserIds?: User["id"][];
+	localOnly?: boolean;
+	channel?: Channel["id"];
+	myReaction?: string;
+	reactions: Record<string, number>;
+	renoteCount: number;
+	repliesCount: number;
+	poll?: {
+		expiresAt: DateString | null;
+		multiple: boolean;
+		choices: {
+			isVoted: boolean;
+			text: string;
+			votes: number;
+		}[];
+	};
+	emojis: {
+		name: string;
+		url: string;
+	}[];
+	uri?: string;
+	url?: string;
+	updatedAt?: DateString;
+	isHidden?: boolean;
+};
+```
+**References:** [ID](./valkyrie-js.entities.id)<!-- -->, [DateString](./valkyrie-js.entities.datestring)<!-- -->, [User](./valkyrie-js.entities.user)<!-- -->, [Note](./valkyrie-js.entities.note)<!-- -->, [DriveFile](./valkyrie-js.entities.drivefile)<!-- -->, [Channel](./valkyrie-js.entities.channel)
+

docs/api/valkyrie-js.entities.notefavorite.md

@@ -0,0 +1,18 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities) &gt; [NoteFavorite](./valkyrie-js.entities.notefavorite)
+
+## entities.NoteFavorite type
+
+**Signature:**
+
+```typescript
+export declare type NoteFavorite = {
+	id: ID;
+	createdAt: DateString;
+	noteId: Note["id"];
+	note: Note;
+};
+```
+**References:** [ID](./valkyrie-js.entities.id)<!-- -->, [DateString](./valkyrie-js.entities.datestring)<!-- -->, [Note](./valkyrie-js.entities.note)
+

docs/api/valkyrie-js.entities.notereaction.md

@@ -0,0 +1,18 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities) &gt; [NoteReaction](./valkyrie-js.entities.notereaction)
+
+## entities.NoteReaction type
+
+**Signature:**
+
+```typescript
+export declare type NoteReaction = {
+	id: ID;
+	createdAt: DateString;
+	user: UserLite;
+	type: string;
+};
+```
+**References:** [ID](./valkyrie-js.entities.id)<!-- -->, [DateString](./valkyrie-js.entities.datestring)<!-- -->, [UserLite](./valkyrie-js.entities.userlite)
+

docs/api/valkyrie-js.entities.notification.md

@@ -0,0 +1,82 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities) &gt; [Notification](./valkyrie-js.entities.notification)
+
+## entities.Notification type
+
+**Signature:**
+
+```typescript
+export declare type Notification = {
+	id: ID;
+	createdAt: DateString;
+	isRead: boolean;
+} & (
+	| {
+			type: "reaction";
+			reaction: string;
+			user: User;
+			userId: User["id"];
+			note: Note;
+	  }
+	| {
+			type: "reply";
+			user: User;
+			userId: User["id"];
+			note: Note;
+	  }
+	| {
+			type: "renote";
+			user: User;
+			userId: User["id"];
+			note: Note;
+	  }
+	| {
+			type: "quote";
+			user: User;
+			userId: User["id"];
+			note: Note;
+	  }
+	| {
+			type: "mention";
+			user: User;
+			userId: User["id"];
+			note: Note;
+	  }
+	| {
+			type: "pollVote";
+			user: User;
+			userId: User["id"];
+			note: Note;
+	  }
+	| {
+			type: "follow";
+			user: User;
+			userId: User["id"];
+	  }
+	| {
+			type: "followRequestAccepted";
+			user: User;
+			userId: User["id"];
+	  }
+	| {
+			type: "receiveFollowRequest";
+			user: User;
+			userId: User["id"];
+	  }
+	| {
+			type: "groupInvited";
+			invitation: UserGroup;
+			user: User;
+			userId: User["id"];
+	  }
+	| {
+			type: "app";
+			header?: string | null;
+			body: string;
+			icon?: string | null;
+	  }
+);
+```
+**References:** [ID](./valkyrie-js.entities.id)<!-- -->, [DateString](./valkyrie-js.entities.datestring)<!-- -->, [User](./valkyrie-js.entities.user)<!-- -->, [Note](./valkyrie-js.entities.note)<!-- -->, [UserGroup](./valkyrie-js.entities.usergroup)
+

docs/api/valkyrie-js.entities.origintype.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities) &gt; [OriginType](./valkyrie-js.entities.origintype)
+
+## entities.OriginType type
+
+**Signature:**
+
+```typescript
+export declare type OriginType = "combined" | "local" | "remote";
+```

docs/api/valkyrie-js.entities.page.md

@@ -0,0 +1,33 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities) &gt; [Page](./valkyrie-js.entities.page)
+
+## entities.Page type
+
+**Signature:**
+
+```typescript
+export declare type Page = {
+	id: ID;
+	createdAt: DateString;
+	updatedAt: DateString;
+	userId: User["id"];
+	user: User;
+	content: Record<string, any>[];
+	variables: Record<string, any>[];
+	title: string;
+	name: string;
+	summary: string | null;
+	hideTitleWhenPinned: boolean;
+	alignCenter: boolean;
+	font: string;
+	script: string;
+	eyeCatchingImageId: DriveFile["id"] | null;
+	eyeCatchingImage: DriveFile | null;
+	attachedFiles: any;
+	likedCount: number;
+	isLiked?: boolean;
+};
+```
+**References:** [ID](./valkyrie-js.entities.id)<!-- -->, [DateString](./valkyrie-js.entities.datestring)<!-- -->, [User](./valkyrie-js.entities.user)<!-- -->, [DriveFile](./valkyrie-js.entities.drivefile)
+

docs/api/valkyrie-js.entities.pageevent.md

@@ -0,0 +1,19 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities) &gt; [PageEvent](./valkyrie-js.entities.pageevent)
+
+## entities.PageEvent type
+
+**Signature:**
+
+```typescript
+export declare type PageEvent = {
+	pageId: Page["id"];
+	event: string;
+	var: any;
+	userId: User["id"];
+	user: User;
+};
+```
+**References:** [Page](./valkyrie-js.entities.page)<!-- -->, [User](./valkyrie-js.entities.user)
+

docs/api/valkyrie-js.entities.serverinfo.md

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities) &gt; [ServerInfo](./valkyrie-js.entities.serverinfo)
+
+## entities.ServerInfo type
+
+**Signature:**
+
+```typescript
+export declare type ServerInfo = {
+	machine: string;
+	cpu: {
+		model: string;
+		cores: number;
+	};
+	mem: {
+		total: number;
+	};
+	fs: {
+		total: number;
+		used: number;
+	};
+};
+```

docs/api/valkyrie-js.entities.signin.md

@@ -0,0 +1,19 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities) &gt; [Signin](./valkyrie-js.entities.signin)
+
+## entities.Signin type
+
+**Signature:**
+
+```typescript
+export declare type Signin = {
+	id: ID;
+	createdAt: DateString;
+	ip: string;
+	headers: Record<string, any>;
+	success: boolean;
+};
+```
+**References:** [ID](./valkyrie-js.entities.id)<!-- -->, [DateString](./valkyrie-js.entities.datestring)
+

docs/api/valkyrie-js.entities.stats.md

@@ -0,0 +1,19 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities) &gt; [Stats](./valkyrie-js.entities.stats)
+
+## entities.Stats type
+
+**Signature:**
+
+```typescript
+export declare type Stats = {
+	notesCount: number;
+	originalNotesCount: number;
+	usersCount: number;
+	originalUsersCount: number;
+	instances: number;
+	driveUsageLocal: number;
+	driveUsageRemote: number;
+};
+```

docs/api/valkyrie-js.entities.user.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities) &gt; [User](./valkyrie-js.entities.user)
+
+## entities.User type
+
+**Signature:**
+
+```typescript
+export declare type User = UserLite | UserDetailed;
+```
+**References:** [UserLite](./valkyrie-js.entities.userlite)<!-- -->, [UserDetailed](./valkyrie-js.entities.userdetailed)
+

docs/api/valkyrie-js.entities.userdetailed.md

@@ -0,0 +1,56 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities) &gt; [UserDetailed](./valkyrie-js.entities.userdetailed)
+
+## entities.UserDetailed type
+
+**Signature:**
+
+```typescript
+export declare type UserDetailed = UserLite & {
+	bannerBlurhash: string | null;
+	bannerColor: string | null;
+	bannerUrl: string | null;
+	birthday: string | null;
+	createdAt: DateString;
+	description: string | null;
+	ffVisibility: "public" | "followers" | "private";
+	fields: {
+		name: string;
+		value: string;
+	}[];
+	followersCount: number;
+	followingCount: number;
+	hasPendingFollowRequestFromYou: boolean;
+	hasPendingFollowRequestToYou: boolean;
+	isAdmin: boolean;
+	isBlocked: boolean;
+	isBlocking: boolean;
+	isBot: boolean;
+	isCat: boolean;
+	isFollowed: boolean;
+	isFollowing: boolean;
+	isLocked: boolean;
+	isModerator: boolean;
+	isMuted: boolean;
+	isRenoteMuted: boolean;
+	isSilenced: boolean;
+	isSuspended: boolean;
+	lang: string | null;
+	lastFetchedAt?: DateString;
+	location: string | null;
+	notesCount: number;
+	pinnedNoteIds: ID[];
+	pinnedNotes: Note[];
+	pinnedPage: Page | null;
+	pinnedPageId: string | null;
+	publicReactions: boolean;
+	securityKeys: boolean;
+	twoFactorEnabled: boolean;
+	updatedAt: DateString | null;
+	uri: string | null;
+	url: string | null;
+};
+```
+**References:** [UserLite](./valkyrie-js.entities.userlite)<!-- -->, [DateString](./valkyrie-js.entities.datestring)<!-- -->, [ID](./valkyrie-js.entities.id)<!-- -->, [Note](./valkyrie-js.entities.note)<!-- -->, [Page](./valkyrie-js.entities.page)
+

docs/api/valkyrie-js.entities.usergroup.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities) &gt; [UserGroup](./valkyrie-js.entities.usergroup)
+
+## entities.UserGroup type
+
+**Signature:**
+
+```typescript
+export declare type UserGroup = TODO;
+```

docs/api/valkyrie-js.entities.userlist.md

@@ -0,0 +1,18 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities) &gt; [UserList](./valkyrie-js.entities.userlist)
+
+## entities.UserList type
+
+**Signature:**
+
+```typescript
+export declare type UserList = {
+	id: ID;
+	createdAt: DateString;
+	name: string;
+	userIds: User["id"][];
+};
+```
+**References:** [ID](./valkyrie-js.entities.id)<!-- -->, [DateString](./valkyrie-js.entities.datestring)<!-- -->, [User](./valkyrie-js.entities.user)
+

docs/api/valkyrie-js.entities.userlite.md

@@ -0,0 +1,35 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities) &gt; [UserLite](./valkyrie-js.entities.userlite)
+
+## entities.UserLite type
+
+**Signature:**
+
+```typescript
+export declare type UserLite = {
+	id: ID;
+	username: string;
+	host: string | null;
+	name: string;
+	onlineStatus: "online" | "active" | "offline" | "unknown";
+	avatarUrl: string;
+	avatarBlurhash: string;
+	alsoKnownAs: string[];
+	movedToUri: any;
+	emojis: {
+		name: string;
+		url: string;
+	}[];
+	instance?: {
+		name: Instance["name"];
+		softwareName: Instance["softwareName"];
+		softwareVersion: Instance["softwareVersion"];
+		iconUrl: Instance["iconUrl"];
+		faviconUrl: Instance["faviconUrl"];
+		themeColor: Instance["themeColor"];
+	};
+};
+```
+**References:** [ID](./valkyrie-js.entities.id)<!-- -->, [Instance](./valkyrie-js.entities.instance)
+

docs/api/valkyrie-js.entities.usersorting.md

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [entities](./valkyrie-js.entities) &gt; [UserSorting](./valkyrie-js.entities.usersorting)
+
+## entities.UserSorting type
+
+**Signature:**
+
+```typescript
+export declare type UserSorting =
+	| "+follower"
+	| "-follower"
+	| "+createdAt"
+	| "-createdAt"
+	| "+updatedAt"
+	| "-updatedAt";
+```

docs/api/valkyrie-js.ffvisibility.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [ffVisibility](./valkyrie-js.ffvisibility)
+
+## ffVisibility variable
+
+**Signature:**
+
+```typescript
+ffVisibility: readonly ["public", "followers", "private"]
+```

docs/api/valkyrie-js.md

@@ -0,0 +1,43 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [valkyrie-js](./valkyrie-js)
+
+## valkyrie-js package
+
+## Classes
+
+|  Class | Description |
+|  --- | --- |
+|  [Stream](./valkyrie-js.stream) |  |
+
+## Abstract Classes
+
+|  Abstract Class | Description |
+|  --- | --- |
+|  [ChannelConnection](./valkyrie-js.channelconnection) |  |
+
+## Namespaces
+
+|  Namespace | Description |
+|  --- | --- |
+|  [api](./valkyrie-js.api) |  |
+|  [entities](./valkyrie-js.entities) |  |
+
+## Variables
+
+|  Variable | Description |
+|  --- | --- |
+|  [ffVisibility](./valkyrie-js.ffvisibility) |  |
+|  [mutedNoteReasons](./valkyrie-js.mutednotereasons) |  |
+|  [noteVisibilities](./valkyrie-js.notevisibilities) |  |
+|  [notificationTypes](./valkyrie-js.notificationtypes) |  |
+|  [permissions](./valkyrie-js.permissions) |  |
+
+## Type Aliases
+
+|  Type Alias | Description |
+|  --- | --- |
+|  [Acct](./valkyrie-js.acct) |  |
+|  [Channels](./valkyrie-js.channels) |  |
+|  [Endpoints](./valkyrie-js.endpoints) |  |
+

docs/api/valkyrie-js.mutednotereasons.md

@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [mutedNoteReasons](./valkyrie-js.mutednotereasons)
+
+## mutedNoteReasons variable
+
+**Signature:**
+
+```typescript
+mutedNoteReasons: readonly [
+	"word",
+	"manual",
+	"spam",
+	"other",
+]
+```

docs/api/valkyrie-js.notevisibilities.md

@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [noteVisibilities](./valkyrie-js.notevisibilities)
+
+## noteVisibilities variable
+
+**Signature:**
+
+```typescript
+noteVisibilities: readonly [
+	"public",
+	"home",
+	"followers",
+	"specified",
+]
+```

docs/api/valkyrie-js.notificationtypes.md

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [notificationTypes](./valkyrie-js.notificationtypes)
+
+## notificationTypes variable
+
+**Signature:**
+
+```typescript
+notificationTypes: readonly [
+	"follow",
+	"mention",
+	"reply",
+	"renote",
+	"quote",
+	"reaction",
+	"pollVote",
+	"pollEnded",
+	"receiveFollowRequest",
+	"followRequestAccepted",
+	"groupInvited",
+	"app",
+]
+```

docs/api/valkyrie-js.permissions.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [permissions](./valkyrie-js.permissions)
+
+## permissions variable
+
+**Signature:**
+
+```typescript
+permissions: string[]
+```

docs/api/valkyrie-js.stream._constructor_.md

@@ -0,0 +1,30 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [Stream](./valkyrie-js.stream) &gt; [(constructor)](./valkyrie-js.stream._constructor_)
+
+## Stream.(constructor)
+
+Constructs a new instance of the `Stream` class
+
+**Signature:**
+
+```typescript
+constructor(
+		origin: string,
+		user: {
+			token: string;
+		} | null,
+		options?: {
+			WebSocket?: any;
+		},
+	);
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  origin | string |  |
+|  user | { token: string; } \| null |  |
+|  options | { WebSocket?: any; } | _(Optional)_ |
+

docs/api/valkyrie-js.stream.close.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [Stream](./valkyrie-js.stream) &gt; [close](./valkyrie-js.stream.close)
+
+## Stream.close() method
+
+**Signature:**
+
+```typescript
+close(): void;
+```
+**Returns:**
+
+void
+

docs/api/valkyrie-js.stream.disconnecttochannel.md

@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [Stream](./valkyrie-js.stream) &gt; [disconnectToChannel](./valkyrie-js.stream.disconnecttochannel)
+
+## Stream.disconnectToChannel() method
+
+**Signature:**
+
+```typescript
+disconnectToChannel(connection: NonSharedConnection): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  connection | NonSharedConnection |  |
+
+**Returns:**
+
+void
+

docs/api/valkyrie-js.stream.md

@@ -0,0 +1,36 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [Stream](./valkyrie-js.stream)
+
+## Stream class
+
+**Signature:**
+
+```typescript
+export default class Stream extends EventEmitter<StreamEvents> 
+```
+**Extends:** EventEmitter&lt;StreamEvents&gt;
+
+## Constructors
+
+|  Constructor | Modifiers | Description |
+|  --- | --- | --- |
+|  [(constructor)(origin, user, options)](./valkyrie-js.stream._constructor_) |  | Constructs a new instance of the <code>Stream</code> class |
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [state](./valkyrie-js.stream.state) |  | "initializing" \| "reconnecting" \| "connected" |  |
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [close()](./valkyrie-js.stream.close) |  |  |
+|  [disconnectToChannel(connection)](./valkyrie-js.stream.disconnecttochannel) |  |  |
+|  [removeSharedConnection(connection)](./valkyrie-js.stream.removesharedconnection) |  |  |
+|  [removeSharedConnectionPool(pool)](./valkyrie-js.stream.removesharedconnectionpool) |  |  |
+|  [send(typeOrPayload, payload)](./valkyrie-js.stream.send) |  |  |
+|  [useChannel(channel, params, name)](./valkyrie-js.stream.usechannel) |  |  |
+

docs/api/valkyrie-js.stream.removesharedconnection.md

@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [Stream](./valkyrie-js.stream) &gt; [removeSharedConnection](./valkyrie-js.stream.removesharedconnection)
+
+## Stream.removeSharedConnection() method
+
+**Signature:**
+
+```typescript
+removeSharedConnection(connection: SharedConnection): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  connection | SharedConnection |  |
+
+**Returns:**
+
+void
+

docs/api/valkyrie-js.stream.removesharedconnectionpool.md

@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [Stream](./valkyrie-js.stream) &gt; [removeSharedConnectionPool](./valkyrie-js.stream.removesharedconnectionpool)
+
+## Stream.removeSharedConnectionPool() method
+
+**Signature:**
+
+```typescript
+removeSharedConnectionPool(pool: Pool): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  pool | Pool |  |
+
+**Returns:**
+
+void
+

docs/api/valkyrie-js.stream.send.md

@@ -0,0 +1,23 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [Stream](./valkyrie-js.stream) &gt; [send](./valkyrie-js.stream.send)
+
+## Stream.send() method
+
+**Signature:**
+
+```typescript
+send(typeOrPayload: any, payload?: any): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  typeOrPayload | any |  |
+|  payload | any | _(Optional)_ |
+
+**Returns:**
+
+void
+

docs/api/valkyrie-js.stream.state.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [Stream](./valkyrie-js.stream) &gt; [state](./valkyrie-js.stream.state)
+
+## Stream.state property
+
+**Signature:**
+
+```typescript
+state: "initializing" | "reconnecting" | "connected";
+```

docs/api/valkyrie-js.stream.usechannel.md

@@ -0,0 +1,28 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index) &gt; [valkyrie-js](./valkyrie-js) &gt; [Stream](./valkyrie-js.stream) &gt; [useChannel](./valkyrie-js.stream.usechannel)
+
+## Stream.useChannel() method
+
+**Signature:**
+
+```typescript
+useChannel<C extends keyof Channels>(
+		channel: C,
+		params?: Channels[C]["params"],
+		name?: string,
+	): Connection<Channels[C]>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  channel | C |  |
+|  params | [Channels](./valkyrie-js.channels)<!-- -->\[C\]\["params"\] | _(Optional)_ |
+|  name | string | _(Optional)_ |
+
+**Returns:**
+
+[Connection](./valkyrie-js.channelconnection)<!-- -->&lt;[Channels](./valkyrie-js.channels)<!-- -->\[C\]&gt;
+