teidesu/mtcute
1
0
Fork 0
Code Issues 15 Pull requests 1 Projects Releases Packages Wiki Activity Actions
mtcute/packages/file-id
History
Alina Sireneva 958f7ff81c
ci: release building
2023-11-01 01:03:49 +03:00
..
src ESM + end-to-end tests (#11) 2023-10-16 19:23:53 +03:00
tests ESM + end-to-end tests (#11) 2023-10-16 19:23:53 +03:00
package.json ci: release building 2023-11-01 01:03:49 +03:00
README.md refactor: changed stylizing of the name (MTCute -> mtcute) 2022-09-14 16:18:56 +03:00
tsconfig.json ESM + end-to-end tests (#11) 2023-10-16 19:23:53 +03:00
typedoc.cjs docs: updated typedoc, added ci, fixed some docs 2023-10-27 14:25:21 +03:00

README.md

@mtcute/file-id

A package that is used internally by @mtcute/client to parse, serialize and manipulate TDLib and Bot API compatible File IDs, but can also be used for any other purposes.

Contents

This package exports a number of functions, namely:

  • parseFileId() which parses provided File ID to an object representing its contents
  • toFileId() which serializes provided object containing file info to a File ID
  • toUniqueFileId() which serializes provided object containing file info to a Unique File ID
  • fileIdTo*() which converts a File ID to an input TL object, which can be used in RPC calls etc.

This package also exports namespace tdFileId, which contains all the types used by the library

Acknowledgements

This is basically a port of a portion of TDLib APIs, but greatly simplified in usage and made to work seamlessly with the rest of the mtcute APIs.

This is a list of files from TDLib repository, from which most of the code was taken:

Additionally, some of the test cases were taken from a similar Python library, luckydonald/telegram_file_id