teidesu/mtcute
1
0
Fork 0
Code Issues 15 Pull requests 1 Projects Releases Packages Wiki Activity Actions

docs(core): improved docs for some methods

Browse source
This commit is contained in:
alina 🌸 2024-12-07 05:47:39 +03:00
parent a5fc092d97
commit 28eb1a6bfd
Signed by: teidesu
SSH key fingerprint: SHA256:uNeCpw6aTSU4aIObXLvHfLkDa82HWH9EiOj9AXOIRpI
2 changed files with 5 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
packages/core/src/highlevel/methods/messages/get-history.ts
View file

@ -70,8 +70,6 @@ export async function getHistory(
/** /**
* Maximum message ID to return. * Maximum message ID to return.
* *
* Unless {@link addOffset} is used, this will work the same as {@link offset}.
*
* @default `0` (disabled). * @default `0` (disabled).
*/ */
maxId?: number maxId?: number

6
packages/core/src/highlevel/types/messages/message-forward.ts
View file

@ -45,7 +45,9 @@ export class MessageForwardInfo {
/** /**
* For "saved" messages (i.e. messages forwarded to yourself, * 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 { fromChat(): Chat | null {
if (!this.raw.savedFromPeer) return null if (!this.raw.savedFromPeer) return null
@ -56,6 +58,8 @@ export class MessageForwardInfo {
/** /**
* For messages forwarded from channels, * For messages forwarded from channels,
* identifier of the original message in the channel * identifier of the original message in the channel
*
* (only availale if {@link fromChat} is not `null`)
*/ */
get fromMessageId(): number | null { get fromMessageId(): number | null {
return this.raw.savedFromMsgId ?? null return this.raw.savedFromMsgId ?? null