jormungandr-bite/packages/iceshrimp-sdk/markdown/iceshrimp-sdk.entities.note.md
Laura Hausmann 91dddc439f
[sdk] Rename iceshrimp-js package to iceshrimp-sdk
This resolves possible confusion between iceshrimp-js (this project) and iceshrimp-sdk (the package)
2024-07-23 23:15:19 +02:00

1.6 KiB

Home > iceshrimp-sdk > entities > Note

entities.Note type

Signature:

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;
};

References: ID, DateString, User, Note, DriveFile, Channel