yumehaki/FrozenFriendsYume
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Initial commit

Browse Source
This commit is contained in:
yumehaki
2026-07-26 12:29:43 +09:00
parent 5f290dc465
commit 50bfaeafdf
2253 changed files with 318636 additions and 196 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/iceshrimp-sdk/markdown/iceshrimp-sdk.acct.md
+14
View File
@@ -0,0 +1,14 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [iceshrimp-sdk](./iceshrimp-sdk.md) &gt; [Acct](./iceshrimp-sdk.acct.md)
## Acct type
**Signature:**
```typescript
export type Acct = {
username: string;
host: string | null;
};
```
packages/iceshrimp-sdk/markdown/iceshrimp-sdk.api.apiclient._constructor_.md
+24
View File
@@ -0,0 +1,24 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [iceshrimp-sdk](./iceshrimp-sdk.md) &gt; [api](./iceshrimp-sdk.api.md) &gt; [APIClient](./iceshrimp-sdk.api.apiclient.md) &gt; [(constructor)](./iceshrimp-sdk.api.apiclient._constructor_.md)
## 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](./iceshrimp-sdk.api.apiclient.md)<!-- -->\["origin"\]; credential?: [APIClient](./iceshrimp-sdk.api.apiclient.md)<!-- -->\["credential"\]; fetch?: [APIClient](./iceshrimp-sdk.api.apiclient.md)<!-- -->\["fetch"\] \| null \| undefined; } | |
packages/iceshrimp-sdk/markdown/iceshrimp-sdk.api.apiclient.credential.md
+11
View File
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [iceshrimp-sdk](./iceshrimp-sdk.md) &gt; [api](./iceshrimp-sdk.api.md) &gt; [APIClient](./iceshrimp-sdk.api.apiclient.md) &gt; [credential](./iceshrimp-sdk.api.apiclient.credential.md)
## api.APIClient.credential property
**Signature:**
```typescript
credential: string | null | undefined;
```
packages/iceshrimp-sdk/markdown/iceshrimp-sdk.api.apiclient.fetch.md
+11
View File
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [iceshrimp-sdk](./iceshrimp-sdk.md) &gt; [api](./iceshrimp-sdk.api.md) &gt; [APIClient](./iceshrimp-sdk.api.apiclient.md) &gt; [fetch](./iceshrimp-sdk.api.apiclient.fetch.md)
## api.APIClient.fetch property
**Signature:**
```typescript
fetch: FetchLike;
```
packages/iceshrimp-sdk/markdown/iceshrimp-sdk.api.apiclient.md
+32
View File
@@ -0,0 +1,32 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [iceshrimp-sdk](./iceshrimp-sdk.md) &gt; [api](./iceshrimp-sdk.api.md) &gt; [APIClient](./iceshrimp-sdk.api.apiclient.md)
## api.APIClient class
**Signature:**
```typescript
export declare class APIClient
```
## Constructors
| Constructor | Modifiers | Description |
| --- | --- | --- |
| [(constructor)(opts)](./iceshrimp-sdk.api.apiclient._constructor_.md) | | Constructs a new instance of the <code>APIClient</code> class |
## Properties
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [credential](./iceshrimp-sdk.api.apiclient.credential.md) | | string \| null \| undefined | |
| [fetch](./iceshrimp-sdk.api.apiclient.fetch.md) | | [FetchLike](./iceshrimp-sdk.api.fetchlike.md) | |
| [origin](./iceshrimp-sdk.api.apiclient.origin.md) | | string | |
## Methods
| Method | Modifiers | Description |
| --- | --- | --- |
| [request(endpoint, params, credential)](./iceshrimp-sdk.api.apiclient.request.md) | | |
packages/iceshrimp-sdk/markdown/iceshrimp-sdk.api.apiclient.origin.md
+11
View File
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [iceshrimp-sdk](./iceshrimp-sdk.md) &gt; [api](./iceshrimp-sdk.api.md) &gt; [APIClient](./iceshrimp-sdk.api.apiclient.md) &gt; [origin](./iceshrimp-sdk.api.apiclient.origin.md)
## api.APIClient.origin property
**Signature:**
```typescript
origin: string;
```
packages/iceshrimp-sdk/markdown/iceshrimp-sdk.api.apiclient.request.md
+29
View File
@@ -0,0 +1,29 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [iceshrimp-sdk](./iceshrimp-sdk.md) &gt; [api](./iceshrimp-sdk.api.md) &gt; [APIClient](./iceshrimp-sdk.api.apiclient.md) &gt; [request](./iceshrimp-sdk.api.apiclient.request.md)
## 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](./iceshrimp-sdk.endpoints.md)<!-- -->\[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](./iceshrimp-sdk.endpoints.md)<!-- -->\[E\]\["res"\]\["$switch"\]\["$default"\] : [Endpoints](./iceshrimp-sdk.endpoints.md)<!-- -->\[E\]\["res"\]&gt;
packages/iceshrimp-sdk/markdown/iceshrimp-sdk.api.apierror.md
+17
View File
@@ -0,0 +1,17 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [iceshrimp-sdk](./iceshrimp-sdk.md) &gt; [api](./iceshrimp-sdk.api.md) &gt; [APIError](./iceshrimp-sdk.api.apierror.md)
## api.APIError type
**Signature:**
```typescript
export type APIError = {
id: string;
code: string;
message: string;
kind: "client" | "server";
info: Record<string, any>;
};
```
packages/iceshrimp-sdk/markdown/iceshrimp-sdk.api.fetchlike.md
+19
View File
@@ -0,0 +1,19 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [iceshrimp-sdk](./iceshrimp-sdk.md) &gt; [api](./iceshrimp-sdk.api.md) &gt; [FetchLike](./iceshrimp-sdk.api.fetchlike.md)
## api.FetchLike type
**Signature:**
```typescript
export type FetchLike = (input: string, init?: {
method?: string;
body?: string;
credentials?: RequestCredentials;
cache?: RequestCache;
}) => Promise<{
status: number;
json(): Promise<any>;
}>;
```
packages/iceshrimp-sdk/markdown/iceshrimp-sdk.api.isapierror.md
+22
View File
@@ -0,0 +1,22 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [iceshrimp-sdk](./iceshrimp-sdk.md) &gt; [api](./iceshrimp-sdk.api.md) &gt; [isAPIError](./iceshrimp-sdk.api.isapierror.md)
## api.isAPIError() function
**Signature:**
```typescript
export declare function isAPIError(reason: any): reason is APIError;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| reason | any | |
**Returns:**
reason is [APIError](./iceshrimp-sdk.api.apierror.md)
packages/iceshrimp-sdk/markdown/iceshrimp-sdk.api.md
+25
View File
@@ -0,0 +1,25 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [iceshrimp-sdk](./iceshrimp-sdk.md) &gt; [api](./iceshrimp-sdk.api.md)
## api namespace
## Classes
| Class | Description |
| --- | --- |
| [APIClient](./iceshrimp-sdk.api.apiclient.md) | |
## Functions
| Function | Description |
| --- | --- |
| [isAPIError(reason)](./iceshrimp-sdk.api.isapierror.md) | |
## Type Aliases
| Type Alias | Description |
| --- | --- |
| [APIError](./iceshrimp-sdk.api.apierror.md) | |
| [FetchLike](./iceshrimp-sdk.api.fetchlike.md) | |
packages/iceshrimp-sdk/markdown/iceshrimp-sdk.channelconnection._constructor_.md
+22
View File
@@ -0,0 +1,22 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [iceshrimp-sdk](./iceshrimp-sdk.md) &gt; [ChannelConnection](./iceshrimp-sdk.channelconnection.md) &gt; [(constructor)](./iceshrimp-sdk.channelconnection._constructor_.md)
## 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](./iceshrimp-sdk.stream.md) | |
| channel | string | |
| name | string | _(Optional)_ |
packages/iceshrimp-sdk/markdown/iceshrimp-sdk.channelconnection.channel.md
+11
View File
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [iceshrimp-sdk](./iceshrimp-sdk.md) &gt; [ChannelConnection](./iceshrimp-sdk.channelconnection.md) &gt; [channel](./iceshrimp-sdk.channelconnection.channel.md)
## ChannelConnection.channel property
**Signature:**
```typescript
channel: string;
```
packages/iceshrimp-sdk/markdown/iceshrimp-sdk.channelconnection.dispose.md
+15
View File
@@ -0,0 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [iceshrimp-sdk](./iceshrimp-sdk.md) &gt; [ChannelConnection](./iceshrimp-sdk.channelconnection.md) &gt; [dispose](./iceshrimp-sdk.channelconnection.dispose.md)
## ChannelConnection.dispose() method
**Signature:**
```typescript
abstract dispose(): void;
```
**Returns:**
void
packages/iceshrimp-sdk/markdown/iceshrimp-sdk.channelconnection.id.md
+11
View File
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [iceshrimp-sdk](./iceshrimp-sdk.md) &gt; [ChannelConnection](./iceshrimp-sdk.channelconnection.md) &gt; [id](./iceshrimp-sdk.channelconnection.id.md)
## ChannelConnection.id property
**Signature:**
```typescript
abstract id: string;
```
packages/iceshrimp-sdk/markdown/iceshrimp-sdk.channelconnection.incount.md
+11
View File
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [iceshrimp-sdk](./iceshrimp-sdk.md) &gt; [ChannelConnection](./iceshrimp-sdk.channelconnection.md) &gt; [inCount](./iceshrimp-sdk.channelconnection.incount.md)
## ChannelConnection.inCount property
**Signature:**
```typescript
inCount: number;
```
packages/iceshrimp-sdk/markdown/iceshrimp-sdk.channelconnection.md
+37
View File
@@ -0,0 +1,37 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [iceshrimp-sdk](./iceshrimp-sdk.md) &gt; [ChannelConnection](./iceshrimp-sdk.channelconnection.md)
## 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)](./iceshrimp-sdk.channelconnection._constructor_.md) | | Constructs a new instance of the <code>Connection</code> class |
## Properties
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [channel](./iceshrimp-sdk.channelconnection.channel.md) | | string | |
| [id](./iceshrimp-sdk.channelconnection.id.md) | <code>abstract</code> | string | |
| [inCount](./iceshrimp-sdk.channelconnection.incount.md) | | number | |
| [name?](./iceshrimp-sdk.channelconnection.name.md) | | string | _(Optional)_ |
| [outCount](./iceshrimp-sdk.channelconnection.outcount.md) | | number | |
| [stream](./iceshrimp-sdk.channelconnection.stream.md) | <code>protected</code> | [Stream](./iceshrimp-sdk.stream.md) | |
## Methods
| Method | Modifiers | Description |
| --- | --- | --- |
| [dispose()](./iceshrimp-sdk.channelconnection.dispose.md) | <code>abstract</code> | |
| [send(type, body)](./iceshrimp-sdk.channelconnection.send.md) | | |
packages/iceshrimp-sdk/markdown/iceshrimp-sdk.channelconnection.name.md
+11
View File
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [iceshrimp-sdk](./iceshrimp-sdk.md) &gt; [ChannelConnection](./iceshrimp-sdk.channelconnection.md) &gt; [name](./iceshrimp-sdk.channelconnection.name.md)
## ChannelConnection.name property
**Signature:**
```typescript
name?: string;
```
packages/iceshrimp-sdk/markdown/iceshrimp-sdk.channelconnection.outcount.md
+11
View File
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [iceshrimp-sdk](./iceshrimp-sdk.md) &gt; [ChannelConnection](./iceshrimp-sdk.channelconnection.md) &gt; [outCount](./iceshrimp-sdk.channelconnection.outcount.md)
## ChannelConnection.outCount property
**Signature:**
```typescript
outCount: number;
```
packages/iceshrimp-sdk/markdown/iceshrimp-sdk.channelconnection.send.md
+23
View File
@@ -0,0 +1,23 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [iceshrimp-sdk](./iceshrimp-sdk.md) &gt; [ChannelConnection](./iceshrimp-sdk.channelconnection.md) &gt; [send](./iceshrimp-sdk.channelconnection.send.md)
## 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
packages/iceshrimp-sdk/markdown/iceshrimp-sdk.channelconnection.stream.md
+11
View File
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [iceshrimp-sdk](./iceshrimp-sdk.md) &gt; [ChannelConnection](./iceshrimp-sdk.channelconnection.md) &gt; [stream](./iceshrimp-sdk.channelconnection.stream.md)
## ChannelConnection.stream property
**Signature:**
```typescript
protected stream: Stream;
```
packages/iceshrimp-sdk/markdown/iceshrimp-sdk.channels.md
+143
View File
@@ -0,0 +1,143 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [iceshrimp-sdk](./iceshrimp-sdk.md) &gt; [Channels](./iceshrimp-sdk.channels.md)
## Channels type
**Signature:**
```typescript
export 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](./iceshrimp-sdk.entities.note.md)<!-- -->, [User](./iceshrimp-sdk.entities.user.md)<!-- -->, [MeDetailed](./iceshrimp-sdk.entities.medetailed.md)<!-- -->, [PageEvent](./iceshrimp-sdk.entities.pageevent.md)<!-- -->, [DriveFile](./iceshrimp-sdk.entities.drivefile.md)<!-- -->, [MessagingMessage](./iceshrimp-sdk.entities.messagingmessage.md)<!-- -->, [Antenna](./iceshrimp-sdk.entities.antenna.md)<!-- -->, [UserGroup](./iceshrimp-sdk.entities.usergroup.md)
packages/iceshrimp-sdk/markdown/iceshrimp-sdk.endpoints.md
+1859
View File
File diff suppressed because it is too large Load Diff
packages/iceshrimp-sdk/markdown/iceshrimp-sdk.entities.announcement.md
+21
View File
@@ -0,0 +1,21 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [iceshrimp-sdk](./iceshrimp-sdk.md) &gt; [entities](./iceshrimp-sdk.entities.md) &gt; [Announcement](./iceshrimp-sdk.entities.announcement.md)
## entities.Announcement type
**Signature:**
```typescript
export type Announcement = {
id: ID;
createdAt: DateString;
updatedAt: DateString | null;
text: string;
title: string;
imageUrl: string | null;
isRead?: boolean;
};
```
**References:** [ID](./iceshrimp-sdk.entities.id.md)<!-- -->, [DateString](./iceshrimp-sdk.entities.datestring.md)
packages/iceshrimp-sdk/markdown/iceshrimp-sdk.entities.antenna.md
+29
View File
@@ -0,0 +1,29 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [iceshrimp-sdk](./iceshrimp-sdk.md) &gt; [entities](./iceshrimp-sdk.entities.md) &gt; [Antenna](./iceshrimp-sdk.entities.antenna.md)
## entities.Antenna type
**Signature:**
```typescript
export 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](./iceshrimp-sdk.entities.id.md)<!-- -->, [DateString](./iceshrimp-sdk.entities.datestring.md)
packages/iceshrimp-sdk/markdown/iceshrimp-sdk.entities.app.md
+11
View File
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [iceshrimp-sdk](./iceshrimp-sdk.md) &gt; [entities](./iceshrimp-sdk.entities.md) &gt; [App](./iceshrimp-sdk.entities.app.md)
## entities.App type
**Signature:**
```typescript
export type App = TODO;
```
packages/iceshrimp-sdk/markdown/iceshrimp-sdk.entities.authsession.md
+17
View File
@@ -0,0 +1,17 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [iceshrimp-sdk](./iceshrimp-sdk.md) &gt; [entities](./iceshrimp-sdk.entities.md) &gt; [AuthSession](./iceshrimp-sdk.entities.authsession.md)
## entities.AuthSession type
**Signature:**
```typescript
export type AuthSession = {
id: ID;
app: App;
token: string;
};
```
**References:** [ID](./iceshrimp-sdk.entities.id.md)<!-- -->, [App](./iceshrimp-sdk.entities.app.md)
packages/iceshrimp-sdk/markdown/iceshrimp-sdk.entities.bite.md
+18
View File
@@ -0,0 +1,18 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [iceshrimp-sdk](./iceshrimp-sdk.md) &gt; [entities](./iceshrimp-sdk.entities.md) &gt; [Bite](./iceshrimp-sdk.entities.bite.md)
## entities.Bite type
**Signature:**
```typescript
export type Bite = {
id: ID;
user: UserLite;
targetType: "user" | "bite" | "note";
target: UserLite | Bite | Note;
};
```
**References:** [ID](./iceshrimp-sdk.entities.id.md)<!-- -->, [UserLite](./iceshrimp-sdk.entities.userlite.md)<!-- -->, [Bite](./iceshrimp-sdk.entities.bite.md)<!-- -->, [Note](./iceshrimp-sdk.entities.note.md)
packages/iceshrimp-sdk/markdown/iceshrimp-sdk.entities.blocking.md
+18
View File
@@ -0,0 +1,18 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [iceshrimp-sdk](./iceshrimp-sdk.md) &gt; [entities](./iceshrimp-sdk.entities.md) &gt; [Blocking](./iceshrimp-sdk.entities.blocking.md)
## entities.Blocking type
**Signature:**
```typescript
export type Blocking = {
id: ID;
createdAt: DateString;
blockeeId: User["id"];
blockee: UserDetailed;
};
```
**References:** [ID](./iceshrimp-sdk.entities.id.md)<!-- -->, [DateString](./iceshrimp-sdk.entities.datestring.md)<!-- -->, [User](./iceshrimp-sdk.entities.user.md)<!-- -->, [UserDetailed](./iceshrimp-sdk.entities.userdetailed.md)
packages/iceshrimp-sdk/markdown/iceshrimp-sdk.entities.channel.md
+15
View File
@@ -0,0 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [iceshrimp-sdk](./iceshrimp-sdk.md) &gt; [entities](./iceshrimp-sdk.entities.md) &gt; [Channel](./iceshrimp-sdk.entities.channel.md)
## entities.Channel type
**Signature:**
```typescript
export type Channel = {
id: ID;
};
```
**References:** [ID](./iceshrimp-sdk.entities.id.md)
packages/iceshrimp-sdk/markdown/iceshrimp-sdk.entities.clip.md
+11
View File
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [iceshrimp-sdk](./iceshrimp-sdk.md) &gt; [entities](./iceshrimp-sdk.entities.md) &gt; [Clip](./iceshrimp-sdk.entities.clip.md)
## entities.Clip type
**Signature:**
```typescript
export type Clip = TODO;
```
packages/iceshrimp-sdk/markdown/iceshrimp-sdk.entities.customemoji.md
+17
View File
@@ -0,0 +1,17 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [iceshrimp-sdk](./iceshrimp-sdk.md) &gt; [entities](./iceshrimp-sdk.entities.md) &gt; [CustomEmoji](./iceshrimp-sdk.entities.customemoji.md)
## entities.CustomEmoji type
**Signature:**
```typescript
export type CustomEmoji = {
id: string;
name: string;
url: string;
category: string;
aliases: string[];
};
```
packages/iceshrimp-sdk/markdown/iceshrimp-sdk.entities.datestring.md
+11
View File
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [iceshrimp-sdk](./iceshrimp-sdk.md) &gt; [entities](./iceshrimp-sdk.entities.md) &gt; [DateString](./iceshrimp-sdk.entities.datestring.md)
## entities.DateString type
**Signature:**
```typescript
export type DateString = string;
```
packages/iceshrimp-sdk/markdown/iceshrimp-sdk.entities.detailedinstancemetadata.md
+15
View File
@@ -0,0 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [iceshrimp-sdk](./iceshrimp-sdk.md) &gt; [entities](./iceshrimp-sdk.entities.md) &gt; [DetailedInstanceMetadata](./iceshrimp-sdk.entities.detailedinstancemetadata.md)
## entities.DetailedInstanceMetadata type
**Signature:**
```typescript
export type DetailedInstanceMetadata = LiteInstanceMetadata & {
features: Record<string, any>;
};
```
**References:** [LiteInstanceMetadata](./iceshrimp-sdk.entities.liteinstancemetadata.md)
packages/iceshrimp-sdk/markdown/iceshrimp-sdk.entities.drivefile.md
+26
View File
@@ -0,0 +1,26 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [iceshrimp-sdk](./iceshrimp-sdk.md) &gt; [entities](./iceshrimp-sdk.entities.md) &gt; [DriveFile](./iceshrimp-sdk.entities.drivefile.md)
## entities.DriveFile type
**Signature:**
```typescript
export 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](./iceshrimp-sdk.entities.id.md)<!-- -->, [DateString](./iceshrimp-sdk.entities.datestring.md)
packages/iceshrimp-sdk/markdown/iceshrimp-sdk.entities.drivefolder.md
+11
View File
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [iceshrimp-sdk](./iceshrimp-sdk.md) &gt; [entities](./iceshrimp-sdk.entities.md) &gt; [DriveFolder](./iceshrimp-sdk.entities.drivefolder.md)
## entities.DriveFolder type
**Signature:**
```typescript
export type DriveFolder = TODO;
```
packages/iceshrimp-sdk/markdown/iceshrimp-sdk.entities.following.md
+18
View File
@@ -0,0 +1,18 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [iceshrimp-sdk](./iceshrimp-sdk.md) &gt; [entities](./iceshrimp-sdk.entities.md) &gt; [Following](./iceshrimp-sdk.entities.following.md)
## entities.Following type
**Signature:**
```typescript
export type Following = {
id: ID;
createdAt: DateString;
followerId: User["id"];
followeeId: User["id"];
};
```
**References:** [ID](./iceshrimp-sdk.entities.id.md)<!-- -->, [DateString](./iceshrimp-sdk.entities.datestring.md)<!-- -->, [User](./iceshrimp-sdk.entities.user.md)
packages/iceshrimp-sdk/markdown/iceshrimp-sdk.entities.followingfolloweepopulated.md
+15
View File
@@ -0,0 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [iceshrimp-sdk](./iceshrimp-sdk.md) &gt; [entities](./iceshrimp-sdk.entities.md) &gt; [FollowingFolloweePopulated](./iceshrimp-sdk.entities.followingfolloweepopulated.md)
## entities.FollowingFolloweePopulated type
**Signature:**
```typescript
export type FollowingFolloweePopulated = Following & {
followee: UserDetailed;
};
```
**References:** [Following](./iceshrimp-sdk.entities.following.md)<!-- -->, [UserDetailed](./iceshrimp-sdk.entities.userdetailed.md)
packages/iceshrimp-sdk/markdown/iceshrimp-sdk.entities.followingfollowerpopulated.md
+15
View File
@@ -0,0 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [iceshrimp-sdk](./iceshrimp-sdk.md) &gt; [entities](./iceshrimp-sdk.entities.md) &gt; [FollowingFollowerPopulated](./iceshrimp-sdk.entities.followingfollowerpopulated.md)
## entities.FollowingFollowerPopulated type
**Signature:**
```typescript
export type FollowingFollowerPopulated = Following & {
follower: UserDetailed;
};
```
**References:** [Following](./iceshrimp-sdk.entities.following.md)<!-- -->, [UserDetailed](./iceshrimp-sdk.entities.userdetailed.md)
packages/iceshrimp-sdk/markdown/iceshrimp-sdk.entities.followrequest.md
+17
View File
@@ -0,0 +1,17 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [iceshrimp-sdk](./iceshrimp-sdk.md) &gt; [entities](./iceshrimp-sdk.entities.md) &gt; [FollowRequest](./iceshrimp-sdk.entities.followrequest.md)
## entities.FollowRequest type
**Signature:**
```typescript
export type FollowRequest = {
id: ID;
follower: User;
followee: User;
};
```
**References:** [ID](./iceshrimp-sdk.entities.id.md)<!-- -->, [User](./iceshrimp-sdk.entities.user.md)
packages/iceshrimp-sdk/markdown/iceshrimp-sdk.entities.gallerypost.md
+11
View File
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [iceshrimp-sdk](./iceshrimp-sdk.md) &gt; [entities](./iceshrimp-sdk.entities.md) &gt; [GalleryPost](./iceshrimp-sdk.entities.gallerypost.md)
## entities.GalleryPost type
**Signature:**
```typescript
export type GalleryPost = TODO;
```
packages/iceshrimp-sdk/markdown/iceshrimp-sdk.entities.id.md
+11
View File
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [iceshrimp-sdk](./iceshrimp-sdk.md) &gt; [entities](./iceshrimp-sdk.entities.md) &gt; [ID](./iceshrimp-sdk.entities.id.md)
## entities.ID type
**Signature:**
```typescript
export type ID = string;
```
packages/iceshrimp-sdk/markdown/iceshrimp-sdk.entities.instance.md
+40
View File
@@ -0,0 +1,40 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [iceshrimp-sdk](./iceshrimp-sdk.md) &gt; [entities](./iceshrimp-sdk.entities.md) &gt; [Instance](./iceshrimp-sdk.entities.instance.md)
## entities.Instance type
**Signature:**
```typescript
export 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](./iceshrimp-sdk.entities.id.md)<!-- -->, [DateString](./iceshrimp-sdk.entities.datestring.md)
packages/iceshrimp-sdk/markdown/iceshrimp-sdk.entities.instancemetadata.md
+13
View File
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [iceshrimp-sdk](./iceshrimp-sdk.md) &gt; [entities](./iceshrimp-sdk.entities.md) &gt; [InstanceMetadata](./iceshrimp-sdk.entities.instancemetadata.md)
## entities.InstanceMetadata type
**Signature:**
```typescript
export type InstanceMetadata = LiteInstanceMetadata | DetailedInstanceMetadata;
```
**References:** [LiteInstanceMetadata](./iceshrimp-sdk.entities.liteinstancemetadata.md)<!-- -->, [DetailedInstanceMetadata](./iceshrimp-sdk.entities.detailedinstancemetadata.md)
packages/iceshrimp-sdk/markdown/iceshrimp-sdk.entities.liteinstancemetadata.md
+43
View File
@@ -0,0 +1,43 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [iceshrimp-sdk](./iceshrimp-sdk.md) &gt; [entities](./iceshrimp-sdk.entities.md) &gt; [LiteInstanceMetadata](./iceshrimp-sdk.entities.liteinstancemetadata.md)
## entities.LiteInstanceMetadata type
**Signature:**
```typescript
export 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;
enableGithubIntegration: boolean;
enableDiscordIntegration: boolean;
searchEngine: string;
emojis: CustomEmoji[];
images: {
error: string;
notFound: string;
info: string;
};
};
```
**References:** [CustomEmoji](./iceshrimp-sdk.entities.customemoji.md)
packages/iceshrimp-sdk/markdown/iceshrimp-sdk.entities.md
+51
View File
@@ -0,0 +1,51 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [iceshrimp-sdk](./iceshrimp-sdk.md) &gt; [entities](./iceshrimp-sdk.entities.md)
## entities namespace
## Type Aliases
| Type Alias | Description |
| --- | --- |
| [Announcement](./iceshrimp-sdk.entities.announcement.md) | |
| [Antenna](./iceshrimp-sdk.entities.antenna.md) | |
| [App](./iceshrimp-sdk.entities.app.md) | |
| [AuthSession](./iceshrimp-sdk.entities.authsession.md) | |
| [Bite](./iceshrimp-sdk.entities.bite.md) | |
| [Blocking](./iceshrimp-sdk.entities.blocking.md) | |
| [Channel](./iceshrimp-sdk.entities.channel.md) | |
| [Clip](./iceshrimp-sdk.entities.clip.md) | |
| [CustomEmoji](./iceshrimp-sdk.entities.customemoji.md) | |
| [DateString](./iceshrimp-sdk.entities.datestring.md) | |
| [DetailedInstanceMetadata](./iceshrimp-sdk.entities.detailedinstancemetadata.md) | |
| [DriveFile](./iceshrimp-sdk.entities.drivefile.md) | |
| [DriveFolder](./iceshrimp-sdk.entities.drivefolder.md) | |
| [Following](./iceshrimp-sdk.entities.following.md) | |
| [FollowingFolloweePopulated](./iceshrimp-sdk.entities.followingfolloweepopulated.md) | |
| [FollowingFollowerPopulated](./iceshrimp-sdk.entities.followingfollowerpopulated.md) | |
| [FollowRequest](./iceshrimp-sdk.entities.followrequest.md) | |
| [GalleryPost](./iceshrimp-sdk.entities.gallerypost.md) | |
| [ID](./iceshrimp-sdk.entities.id.md) | |
| [Instance](./iceshrimp-sdk.entities.instance.md) | |
| [InstanceMetadata](./iceshrimp-sdk.entities.instancemetadata.md) | |
| [LiteInstanceMetadata](./iceshrimp-sdk.entities.liteinstancemetadata.md) | |
| [MeDetailed](./iceshrimp-sdk.entities.medetailed.md) | |
| [MessagingMessage](./iceshrimp-sdk.entities.messagingmessage.md) | |
| [Note](./iceshrimp-sdk.entities.note.md) | |
| [NoteFavorite](./iceshrimp-sdk.entities.notefavorite.md) | |
| [NoteReaction](./iceshrimp-sdk.entities.notereaction.md) | |
| [Notification](./iceshrimp-sdk.entities.notification.md) | |
| [OriginType](./iceshrimp-sdk.entities.origintype.md) | |
| [Page](./iceshrimp-sdk.entities.page.md) | |
| [PageEvent](./iceshrimp-sdk.entities.pageevent.md) | |
| [ServerInfo](./iceshrimp-sdk.entities.serverinfo.md) | |
| [Signin](./iceshrimp-sdk.entities.signin.md) | |
| [Stats](./iceshrimp-sdk.entities.stats.md) | |
| [User](./iceshrimp-sdk.entities.user.md) | |
| [UserDetailed](./iceshrimp-sdk.entities.userdetailed.md) | |
| [UserGroup](./iceshrimp-sdk.entities.usergroup.md) | |
| [UserList](./iceshrimp-sdk.entities.userlist.md) | |
| [UserLite](./iceshrimp-sdk.entities.userlite.md) | |
| [UserSorting](./iceshrimp-sdk.entities.usersorting.md) | |
packages/iceshrimp-sdk/markdown/iceshrimp-sdk.entities.medetailed.md
+40
View File
@@ -0,0 +1,40 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [iceshrimp-sdk](./iceshrimp-sdk.md) &gt; [entities](./iceshrimp-sdk.entities.md) &gt; [MeDetailed](./iceshrimp-sdk.entities.medetailed.md)
## entities.MeDetailed type
**Signature:**
```typescript
export 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](./iceshrimp-sdk.entities.userdetailed.md)<!-- -->, [DriveFile](./iceshrimp-sdk.entities.drivefile.md)
packages/iceshrimp-sdk/markdown/iceshrimp-sdk.entities.messagingmessage.md
+27
View File
@@ -0,0 +1,27 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [iceshrimp-sdk](./iceshrimp-sdk.md) &gt; [entities](./iceshrimp-sdk.entities.md) &gt; [MessagingMessage](./iceshrimp-sdk.entities.messagingmessage.md)
## entities.MessagingMessage type
**Signature:**
```typescript
export 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](./iceshrimp-sdk.entities.id.md)<!-- -->, [DateString](./iceshrimp-sdk.entities.datestring.md)<!-- -->, [DriveFile](./iceshrimp-sdk.entities.drivefile.md)<!-- -->, [User](./iceshrimp-sdk.entities.user.md)<!-- -->, [UserGroup](./iceshrimp-sdk.entities.usergroup.md)
packages/iceshrimp-sdk/markdown/iceshrimp-sdk.entities.note.md
+53
View File
@@ -0,0 +1,53 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [iceshrimp-sdk](./iceshrimp-sdk.md) &gt; [entities](./iceshrimp-sdk.entities.md) &gt; [Note](./iceshrimp-sdk.entities.note.md)
## entities.Note type
**Signature:**
```typescript
export 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;
isRenoted?: boolean;
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;
canBite?: boolean;
};
```
**References:** [ID](./iceshrimp-sdk.entities.id.md)<!-- -->, [DateString](./iceshrimp-sdk.entities.datestring.md)<!-- -->, [User](./iceshrimp-sdk.entities.user.md)<!-- -->, [Note](./iceshrimp-sdk.entities.note.md)<!-- -->, [DriveFile](./iceshrimp-sdk.entities.drivefile.md)<!-- -->, [Channel](./iceshrimp-sdk.entities.channel.md)
packages/iceshrimp-sdk/markdown/iceshrimp-sdk.entities.notefavorite.md
+18
View File
@@ -0,0 +1,18 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [iceshrimp-sdk](./iceshrimp-sdk.md) &gt; [entities](./iceshrimp-sdk.entities.md) &gt; [NoteFavorite](./iceshrimp-sdk.entities.notefavorite.md)
## entities.NoteFavorite type
**Signature:**
```typescript
export type NoteFavorite = {
id: ID;
createdAt: DateString;
noteId: Note["id"];
note: Note;
};
```
**References:** [ID](./iceshrimp-sdk.entities.id.md)<!-- -->, [DateString](./iceshrimp-sdk.entities.datestring.md)<!-- -->, [Note](./iceshrimp-sdk.entities.note.md)
packages/iceshrimp-sdk/markdown/iceshrimp-sdk.entities.notereaction.md
+18
View File
@@ -0,0 +1,18 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [iceshrimp-sdk](./iceshrimp-sdk.md) &gt; [entities](./iceshrimp-sdk.entities.md) &gt; [NoteReaction](./iceshrimp-sdk.entities.notereaction.md)
## entities.NoteReaction type
**Signature:**
```typescript
export type NoteReaction = {
id: ID;
createdAt: DateString;
user: UserLite;
type: string;
};
```
**References:** [ID](./iceshrimp-sdk.entities.id.md)<!-- -->, [DateString](./iceshrimp-sdk.entities.datestring.md)<!-- -->, [UserLite](./iceshrimp-sdk.entities.userlite.md)
packages/iceshrimp-sdk/markdown/iceshrimp-sdk.entities.notification.md
+75
View File
@@ -0,0 +1,75 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [iceshrimp-sdk](./iceshrimp-sdk.md) &gt; [entities](./iceshrimp-sdk.entities.md) &gt; [Notification](./iceshrimp-sdk.entities.notification.md)
## entities.Notification type
**Signature:**
```typescript
export 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;
} | {
type: "bite";
user: User;
userId: User["id"];
bite: Bite;
});
```
**References:** [ID](./iceshrimp-sdk.entities.id.md)<!-- -->, [DateString](./iceshrimp-sdk.entities.datestring.md)<!-- -->, [User](./iceshrimp-sdk.entities.user.md)<!-- -->, [Note](./iceshrimp-sdk.entities.note.md)<!-- -->, [UserGroup](./iceshrimp-sdk.entities.usergroup.md)<!-- -->, [Bite](./iceshrimp-sdk.entities.bite.md)
packages/iceshrimp-sdk/markdown/iceshrimp-sdk.entities.origintype.md
+11
View File
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [iceshrimp-sdk](./iceshrimp-sdk.md) &gt; [entities](./iceshrimp-sdk.entities.md) &gt; [OriginType](./iceshrimp-sdk.entities.origintype.md)
## entities.OriginType type
**Signature:**
```typescript
export type OriginType = "combined" | "local" | "remote";
```
packages/iceshrimp-sdk/markdown/iceshrimp-sdk.entities.page.md
+33
View File
@@ -0,0 +1,33 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [iceshrimp-sdk](./iceshrimp-sdk.md) &gt; [entities](./iceshrimp-sdk.entities.md) &gt; [Page](./iceshrimp-sdk.entities.page.md)
## entities.Page type
**Signature:**
```typescript
export 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](./iceshrimp-sdk.entities.id.md)<!-- -->, [DateString](./iceshrimp-sdk.entities.datestring.md)<!-- -->, [User](./iceshrimp-sdk.entities.user.md)<!-- -->, [DriveFile](./iceshrimp-sdk.entities.drivefile.md)
packages/iceshrimp-sdk/markdown/iceshrimp-sdk.entities.pageevent.md
+19
View File
@@ -0,0 +1,19 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [iceshrimp-sdk](./iceshrimp-sdk.md) &gt; [entities](./iceshrimp-sdk.entities.md) &gt; [PageEvent](./iceshrimp-sdk.entities.pageevent.md)
## entities.PageEvent type
**Signature:**
```typescript
export type PageEvent = {
pageId: Page["id"];
event: string;
var: any;
userId: User["id"];
user: User;
};
```
**References:** [Page](./iceshrimp-sdk.entities.page.md)<!-- -->, [User](./iceshrimp-sdk.entities.user.md)
packages/iceshrimp-sdk/markdown/iceshrimp-sdk.entities.serverinfo.md
+24
View File
@@ -0,0 +1,24 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [iceshrimp-sdk](./iceshrimp-sdk.md) &gt; [entities](./iceshrimp-sdk.entities.md) &gt; [ServerInfo](./iceshrimp-sdk.entities.serverinfo.md)
## entities.ServerInfo type
**Signature:**
```typescript
export type ServerInfo = {
machine: string;
cpu: {
model: string;
cores: number;
};
mem: {
total: number;
};
fs: {
total: number;
used: number;
};
};
```
packages/iceshrimp-sdk/markdown/iceshrimp-sdk.entities.signin.md
+19
View File
@@ -0,0 +1,19 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [iceshrimp-sdk](./iceshrimp-sdk.md) &gt; [entities](./iceshrimp-sdk.entities.md) &gt; [Signin](./iceshrimp-sdk.entities.signin.md)
## entities.Signin type
**Signature:**
```typescript
export type Signin = {
id: ID;
createdAt: DateString;
ip: string;
headers: Record<string, any>;
success: boolean;
};
```
**References:** [ID](./iceshrimp-sdk.entities.id.md)<!-- -->, [DateString](./iceshrimp-sdk.entities.datestring.md)
packages/iceshrimp-sdk/markdown/iceshrimp-sdk.entities.stats.md
+19
View File
@@ -0,0 +1,19 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [iceshrimp-sdk](./iceshrimp-sdk.md) &gt; [entities](./iceshrimp-sdk.entities.md) &gt; [Stats](./iceshrimp-sdk.entities.stats.md)
## entities.Stats type
**Signature:**
```typescript
export type Stats = {
notesCount: number;
originalNotesCount: number;
usersCount: number;
originalUsersCount: number;
instances: number;
driveUsageLocal: number;
driveUsageRemote: number;
};
```
packages/iceshrimp-sdk/markdown/iceshrimp-sdk.entities.user.md
+13
View File
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [iceshrimp-sdk](./iceshrimp-sdk.md) &gt; [entities](./iceshrimp-sdk.entities.md) &gt; [User](./iceshrimp-sdk.entities.user.md)
## entities.User type
**Signature:**
```typescript
export type User = UserLite | UserDetailed;
```
**References:** [UserLite](./iceshrimp-sdk.entities.userlite.md)<!-- -->, [UserDetailed](./iceshrimp-sdk.entities.userdetailed.md)
packages/iceshrimp-sdk/markdown/iceshrimp-sdk.entities.userdetailed.md
+59
View File
@@ -0,0 +1,59 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [iceshrimp-sdk](./iceshrimp-sdk.md) &gt; [entities](./iceshrimp-sdk.entities.md) &gt; [UserDetailed](./iceshrimp-sdk.entities.userdetailed.md)
## entities.UserDetailed type
**Signature:**
```typescript
export 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;
verified?: boolean;
}[];
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;
pronouns: Record<string, string>;
canBite: "anyone" | "followers" | "nobody";
};
```
**References:** [UserLite](./iceshrimp-sdk.entities.userlite.md)<!-- -->, [DateString](./iceshrimp-sdk.entities.datestring.md)<!-- -->, [ID](./iceshrimp-sdk.entities.id.md)<!-- -->, [Note](./iceshrimp-sdk.entities.note.md)<!-- -->, [Page](./iceshrimp-sdk.entities.page.md)
packages/iceshrimp-sdk/markdown/iceshrimp-sdk.entities.usergroup.md
+11
View File
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [iceshrimp-sdk](./iceshrimp-sdk.md) &gt; [entities](./iceshrimp-sdk.entities.md) &gt; [UserGroup](./iceshrimp-sdk.entities.usergroup.md)
## entities.UserGroup type
**Signature:**
```typescript
export type UserGroup = TODO;
```
packages/iceshrimp-sdk/markdown/iceshrimp-sdk.entities.userlist.md
+18
View File
@@ -0,0 +1,18 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [iceshrimp-sdk](./iceshrimp-sdk.md) &gt; [entities](./iceshrimp-sdk.entities.md) &gt; [UserList](./iceshrimp-sdk.entities.userlist.md)
## entities.UserList type
**Signature:**
```typescript
export type UserList = {
id: ID;
createdAt: DateString;
name: string;
userIds: User["id"][];
};
```
**References:** [ID](./iceshrimp-sdk.entities.id.md)<!-- -->, [DateString](./iceshrimp-sdk.entities.datestring.md)<!-- -->, [User](./iceshrimp-sdk.entities.user.md)
packages/iceshrimp-sdk/markdown/iceshrimp-sdk.entities.userlite.md
+35
View File
@@ -0,0 +1,35 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [iceshrimp-sdk](./iceshrimp-sdk.md) &gt; [entities](./iceshrimp-sdk.entities.md) &gt; [UserLite](./iceshrimp-sdk.entities.userlite.md)
## entities.UserLite type
**Signature:**
```typescript
export 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](./iceshrimp-sdk.entities.id.md)<!-- -->, [Instance](./iceshrimp-sdk.entities.instance.md)
packages/iceshrimp-sdk/markdown/iceshrimp-sdk.entities.usersorting.md
+11
View File
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [iceshrimp-sdk](./iceshrimp-sdk.md) &gt; [entities](./iceshrimp-sdk.entities.md) &gt; [UserSorting](./iceshrimp-sdk.entities.usersorting.md)
## entities.UserSorting type
**Signature:**
```typescript
export type UserSorting = "+follower" | "-follower" | "+createdAt" | "-createdAt" | "+updatedAt" | "-updatedAt";
```
packages/iceshrimp-sdk/markdown/iceshrimp-sdk.ffvisibility.md
+11
View File
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [iceshrimp-sdk](./iceshrimp-sdk.md) &gt; [ffVisibility](./iceshrimp-sdk.ffvisibility.md)
## ffVisibility variable
**Signature:**
```typescript
ffVisibility: readonly ["public", "followers", "private"]
```
packages/iceshrimp-sdk/markdown/iceshrimp-sdk.md
+42
View File
@@ -0,0 +1,42 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [iceshrimp-sdk](./iceshrimp-sdk.md)
## iceshrimp-sdk package
## Classes
| Class | Description |
| --- | --- |
| [Stream](./iceshrimp-sdk.stream.md) | |
## Abstract Classes
| Abstract Class | Description |
| --- | --- |
| [ChannelConnection](./iceshrimp-sdk.channelconnection.md) | |
## Namespaces
| Namespace | Description |
| --- | --- |
| [api](./iceshrimp-sdk.api.md) | |
| [entities](./iceshrimp-sdk.entities.md) | |
## Variables
| Variable | Description |
| --- | --- |
| [ffVisibility](./iceshrimp-sdk.ffvisibility.md) | |
| [noteVisibilities](./iceshrimp-sdk.notevisibilities.md) | |
| [notificationTypes](./iceshrimp-sdk.notificationtypes.md) | |
| [permissions](./iceshrimp-sdk.permissions.md) | |
## Type Aliases
| Type Alias | Description |
| --- | --- |
| [Acct](./iceshrimp-sdk.acct.md) | |
| [Channels](./iceshrimp-sdk.channels.md) | |
| [Endpoints](./iceshrimp-sdk.endpoints.md) | |
packages/iceshrimp-sdk/markdown/iceshrimp-sdk.notevisibilities.md
+11
View File
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [iceshrimp-sdk](./iceshrimp-sdk.md) &gt; [noteVisibilities](./iceshrimp-sdk.notevisibilities.md)
## noteVisibilities variable
**Signature:**
```typescript
noteVisibilities: readonly ["public", "home", "followers", "specified"]
```
packages/iceshrimp-sdk/markdown/iceshrimp-sdk.notificationtypes.md
+11
View File
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [iceshrimp-sdk](./iceshrimp-sdk.md) &gt; [notificationTypes](./iceshrimp-sdk.notificationtypes.md)
## notificationTypes variable
**Signature:**
```typescript
notificationTypes: readonly ["follow", "mention", "reply", "renote", "quote", "reaction", "pollVote", "pollEnded", "receiveFollowRequest", "followRequestAccepted", "groupInvited", "app", "bite"]
```
packages/iceshrimp-sdk/markdown/iceshrimp-sdk.permissions.md
+11
View File
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [iceshrimp-sdk](./iceshrimp-sdk.md) &gt; [permissions](./iceshrimp-sdk.permissions.md)
## permissions variable
**Signature:**
```typescript
permissions: string[]
```
packages/iceshrimp-sdk/markdown/iceshrimp-sdk.stream._constructor_.md
+26
View File
@@ -0,0 +1,26 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [iceshrimp-sdk](./iceshrimp-sdk.md) &gt; [Stream](./iceshrimp-sdk.stream.md) &gt; [(constructor)](./iceshrimp-sdk.stream._constructor_.md)
## 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)_ |
packages/iceshrimp-sdk/markdown/iceshrimp-sdk.stream.close.md
+15
View File
@@ -0,0 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [iceshrimp-sdk](./iceshrimp-sdk.md) &gt; [Stream](./iceshrimp-sdk.stream.md) &gt; [close](./iceshrimp-sdk.stream.close.md)
## Stream.close() method
**Signature:**
```typescript
close(): void;
```
**Returns:**
void
packages/iceshrimp-sdk/markdown/iceshrimp-sdk.stream.disconnecttochannel.md
+22
View File
@@ -0,0 +1,22 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [iceshrimp-sdk](./iceshrimp-sdk.md) &gt; [Stream](./iceshrimp-sdk.stream.md) &gt; [disconnectToChannel](./iceshrimp-sdk.stream.disconnecttochannel.md)
## Stream.disconnectToChannel() method
**Signature:**
```typescript
disconnectToChannel(connection: NonSharedConnection): void;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| connection | NonSharedConnection | |
**Returns:**
void
packages/iceshrimp-sdk/markdown/iceshrimp-sdk.stream.md
+36
View File
@@ -0,0 +1,36 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [iceshrimp-sdk](./iceshrimp-sdk.md) &gt; [Stream](./iceshrimp-sdk.stream.md)
## Stream class
**Signature:**
```typescript
export default class Stream extends EventEmitter<StreamEvents>
```
**Extends:** EventEmitter&lt;StreamEvents&gt;
## Constructors
| Constructor | Modifiers | Description |
| --- | --- | --- |
| [(constructor)(origin, user, options)](./iceshrimp-sdk.stream._constructor_.md) | | Constructs a new instance of the <code>Stream</code> class |
## Properties
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [state](./iceshrimp-sdk.stream.state.md) | | "initializing" \| "reconnecting" \| "connected" | |
## Methods
| Method | Modifiers | Description |
| --- | --- | --- |
| [close()](./iceshrimp-sdk.stream.close.md) | | |
| [disconnectToChannel(connection)](./iceshrimp-sdk.stream.disconnecttochannel.md) | | |
| [removeSharedConnection(connection)](./iceshrimp-sdk.stream.removesharedconnection.md) | | |
| [removeSharedConnectionPool(pool)](./iceshrimp-sdk.stream.removesharedconnectionpool.md) | | |
| [send(typeOrPayload, payload)](./iceshrimp-sdk.stream.send.md) | | |
| [useChannel(channel, params, name)](./iceshrimp-sdk.stream.usechannel.md) | | |
packages/iceshrimp-sdk/markdown/iceshrimp-sdk.stream.removesharedconnection.md
+22
View File
@@ -0,0 +1,22 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [iceshrimp-sdk](./iceshrimp-sdk.md) &gt; [Stream](./iceshrimp-sdk.stream.md) &gt; [removeSharedConnection](./iceshrimp-sdk.stream.removesharedconnection.md)
## Stream.removeSharedConnection() method
**Signature:**
```typescript
removeSharedConnection(connection: SharedConnection): void;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| connection | SharedConnection | |
**Returns:**
void
packages/iceshrimp-sdk/markdown/iceshrimp-sdk.stream.removesharedconnectionpool.md
+22
View File
@@ -0,0 +1,22 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [iceshrimp-sdk](./iceshrimp-sdk.md) &gt; [Stream](./iceshrimp-sdk.stream.md) &gt; [removeSharedConnectionPool](./iceshrimp-sdk.stream.removesharedconnectionpool.md)
## Stream.removeSharedConnectionPool() method
**Signature:**
```typescript
removeSharedConnectionPool(pool: Pool): void;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| pool | Pool | |
**Returns:**
void
packages/iceshrimp-sdk/markdown/iceshrimp-sdk.stream.send.md
+23
View File
@@ -0,0 +1,23 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [iceshrimp-sdk](./iceshrimp-sdk.md) &gt; [Stream](./iceshrimp-sdk.stream.md) &gt; [send](./iceshrimp-sdk.stream.send.md)
## Stream.send() method
**Signature:**
```typescript
send(typeOrPayload: any, payload?: any): void;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| typeOrPayload | any | |
| payload | any | _(Optional)_ |
**Returns:**
void
packages/iceshrimp-sdk/markdown/iceshrimp-sdk.stream.state.md
+11
View File
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [iceshrimp-sdk](./iceshrimp-sdk.md) &gt; [Stream](./iceshrimp-sdk.stream.md) &gt; [state](./iceshrimp-sdk.stream.state.md)
## Stream.state property
**Signature:**
```typescript
state: "initializing" | "reconnecting" | "connected";
```
packages/iceshrimp-sdk/markdown/iceshrimp-sdk.stream.usechannel.md
+24
View File
@@ -0,0 +1,24 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [iceshrimp-sdk](./iceshrimp-sdk.md) &gt; [Stream](./iceshrimp-sdk.stream.md) &gt; [useChannel](./iceshrimp-sdk.stream.usechannel.md)
## 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](./iceshrimp-sdk.channels.md)<!-- -->\[C\]\["params"\] | _(Optional)_ |
| name | string | _(Optional)_ |
**Returns:**
[Connection](./iceshrimp-sdk.channelconnection.md)<!-- -->&lt;[Channels](./iceshrimp-sdk.channels.md)<!-- -->\[C\]&gt;
packages/iceshrimp-sdk/markdown/index.md
+12
View File
@@ -0,0 +1,12 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md)
## API Reference
## Packages
| Package | Description |
| --- | --- |
| [iceshrimp-sdk](./iceshrimp-sdk.md) | |