From 28eb1a6bfd3c2db5cabdd5d053adf907255a4393 Mon Sep 17 00:00:00 2001 From: alina sireneva Date: Sat, 7 Dec 2024 05:47:39 +0300 Subject: [PATCH] docs(core): improved docs for some methods --- packages/core/src/highlevel/methods/messages/get-history.ts | 2 -- .../core/src/highlevel/types/messages/message-forward.ts | 6 +++++- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/packages/core/src/highlevel/methods/messages/get-history.ts b/packages/core/src/highlevel/methods/messages/get-history.ts index f840f174..b11547a1 100644 --- a/packages/core/src/highlevel/methods/messages/get-history.ts +++ b/packages/core/src/highlevel/methods/messages/get-history.ts @@ -70,8 +70,6 @@ export async function getHistory( /** * Maximum message ID to return. * - * Unless {@link addOffset} is used, this will work the same as {@link offset}. - * * @default `0` (disabled). */ maxId?: number diff --git a/packages/core/src/highlevel/types/messages/message-forward.ts b/packages/core/src/highlevel/types/messages/message-forward.ts index bcfd74f5..592a5570 100644 --- a/packages/core/src/highlevel/types/messages/message-forward.ts +++ b/packages/core/src/highlevel/types/messages/message-forward.ts @@ -45,7 +45,9 @@ export class MessageForwardInfo { /** * For "saved" messages (i.e. messages forwarded to yourself, - * "Saved Messages"), the peer where the message was originally sent + * "Saved Messages"), the peer where the message was originally sent. + * + * `null` for other messages, you might want to use {@link sender} instead */ fromChat(): Chat | null { if (!this.raw.savedFromPeer) return null @@ -56,6 +58,8 @@ export class MessageForwardInfo { /** * For messages forwarded from channels, * identifier of the original message in the channel + * + * (only availale if {@link fromChat} is not `null`) */ get fromMessageId(): number | null { return this.raw.savedFromMsgId ?? null