History

mtcute-bot 59c6ae4cbf v0.1.0		2023-11-01 19:56:23 +00: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	v0.1.0	2023-11-01 19:56:23 +00:00
README.md	docs: updated packages readmes	2023-11-01 14:05:45 +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

📖 API Reference

This package 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.

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