Code
Hub
Workspaces
Following
Trending
Connect
MCP
copy
Create free account
hub
/
github.com/alkihis/twitter-archive-reader
/ functions
Functions
335 in github.com/alkihis/twitter-archive-reader
⨍
Functions
335
◇
Types & classes
148
Method
encrypted
()
ts/reading/StreamZip.ts:833
Method
entry
(name: string)
ts/reading/StreamZip.ts:466
Function
events
* Get all the events related to this conversation, sorted by date, from oldest to newest. * * By default, this does not include messages, only o
ts/direct_messages/Conversation.ts:448
Method
expandRight
(length: number)
ts/reading/StreamZip.ts:938
Method
favorites
* Access to the `FavoriteArchive` object. Contains all the favorited tweets of the archive. * * If `.is_gdpr === false`, this container will be
ts/TwitterArchive.ts:665
Method
files
()
ts/MediaArchive.ts:483
Method
files
()
ts/reading/FolderArchive.ts:285
Method
files
()
ts/reading/StreamArchive.ts:315
Function
find
Find direct messages that matches a query on their text.
ts/direct_messages/Conversation.ts:85
Method
find
* Find tweets matching **query** in this tweet archive. * * This is a shortcut of `.finder.search(tweets, ...)` * * --- * * **Docume
ts/tweets/TweetArchive.ts:319
Method
finder
* Returns the local `TweetFinder` instance assigned to this `TweetArchive`. * * A global exported instance also exists and named `TweetSearcher`
ts/tweets/TweetArchive.ts:403
Function
first
First DM in this conversation. Access to next messages with LinkedDirectMessage.next
ts/direct_messages/Conversation.ts:429
Method
first
()
ts/direct_messages/Conversation.ts:694
Method
followers
* Access to a set of followers IDs. * * If `.is_gdpr === false`, this container will be empty.
ts/TwitterArchive.ts:674
Method
followings
* Access to a set of followings user IDs. * * If `.is_gdpr === false`, this container will be empty.
ts/TwitterArchive.ts:683
Function
from
(ids: string | Iterable<string>)
ts/direct_messages/Conversation.ts:129
Method
fromFile
(name: string | FolderEntry)
ts/reading/FolderArchive.ts:274
Method
fromFile
(name: string | ZipEntry)
ts/reading/StreamArchive.ts:304
Method
fromMomentDirectory
* Extract a moment header image from GDPR archive (exact filename required). * * In order to have tweets medias inside the moments (duplicated b
ts/MediaArchive.ts:276
Function
fromThatDay
* Get conversation of the same day as {day}, but also in previous years. * * {day} can be omitted (refers to today), be a `Date` object, or be a
ts/direct_messages/Conversation.ts:271
Method
fromThatDay
(start?: Date)
ts/tweets/FavoriteArchive.ts:64
Method
fromThatDay
(start?: Date)
ts/tweets/TweetArchive.ts:15
Method
fromThatDay
Find tweets made on the same day as {start} (= month, = day), but in all years. {start} defaults to now.
ts/tweets/TweetArchive.ts:146
Method
generation_date
* Archive creation date. * * **Warning**: This is accurate only for classic archives (< 2018, tweet only), * or GDPR archives produced after
ts/TwitterArchive.ts:582
Method
groups
Group conversations
ts/direct_messages/DMArchive.ts:130
Function
has
Check if message {id} exists in this conversation.
ts/direct_messages/Conversation.ts:234
Method
has
(name: string)
ts/reading/FolderArchive.ts:113
Method
has
(name: string)
ts/reading/StreamArchive.ts:134
Method
has
* Check if {tweet_id} has been favorited.
ts/tweets/FavoriteArchive.ts:31
Method
has
Check if tweet {id_str} exists in this archive.
ts/tweets/TweetArchive.ts:262
Method
hasClickedLink
* Tells if URL {link} has been clicked by user.
ts/tweets/TweetArchive.ts:436
Method
hasClickedTo
* Tells if tweet {id_str} has been clicked.
ts/tweets/TweetArchive.ts:429
Method
hasOrEmpty
(element: ArchiveReadPart)
ts/TwitterArchive.ts:273
Method
has_extended_favorites
`true` if this archive's favorites supported "extended" properties: `.fullText` and `.expandedUrl`.
ts/tweets/FavoriteArchive.ts:178
Method
has_manifest
* `true` if archive have a manifest file inside. * * This only applies to GDPR archives produced by Twitter after mid-March 2020.
ts/TwitterArchive.ts:619
Method
has_medias
()
ts/MediaArchive.ts:289
Method
has_viewer
* `true` if the current archive have an Twitter HTML viewer integrated.
ts/TwitterArchive.ts:610
Method
hash
* Create a pseudo-unique hash from a archive information (number of tweets, owner, last tweet date...), * in order to have a fingerprint of one arc
ts/TwitterArchive.ts:1043
Method
id
Conversation ID
ts/direct_messages/Conversation.ts:690
Method
id
User ID.
ts/user/UserData.ts:499
Function
id_index
Map message IDs to messages objets.
ts/direct_messages/Conversation.ts:413
Method
id_index
* Index of tweets by ID.
ts/tweets/TweetArchive.ts:372
Method
impressions_by_advertiser
* Impressions by advertiser screen name (with @ in it). * * Real advertiser name can be obtains with `impression.advertiserInfo.advertiserName`
ts/user/AdArchive.ts:57
Method
impressions_by_engagement_type
* All impressions linked to an engagement, sorted by engagement types. * * A single impression can have multiple engagement types.
ts/user/AdArchive.ts:77
Method
impressions_by_location
* Impressions by display location (where archive owner seen it on Twitter environnement: Timeline, profile...)
ts/user/AdArchive.ts:37
Function
index
Count of total messages, messages per year, month, day, plus the messages themselves.
ts/direct_messages/Conversation.ts:332
Method
index
* Favorites sorted by year then months. * * Favs on `2010-10` are favorites than cannot be date classed.
ts/tweets/FavoriteArchive.ts:134
Method
index
* Index of tweets by years. * * Example, get index of tweets posted on 2019/01 : * **<index>.years[2019][1]**
ts/tweets/TweetArchive.ts:339
Function
index_by_date
()
ts/direct_messages/Conversation.ts:372
Method
indexed
`true` if a conversation is indexed. If `false`, a call to `.indexate()` is required.
ts/direct_messages/Conversation.ts:496
Method
info
* Archive quick information. * * - `.info.archive` : `{ created_at: string, tweets: number }` * - `.info.user`: See `TwitterUserDetails`
ts/TwitterArchive.ts:592
Function
infos
()
ts/direct_messages/Conversation.ts:424
Function
isGDPRTweet
(tweet: PartialTweetGDPR | PartialTweet)
ts/utils/exported_helpers.ts:187
Function
isWithMedia
(tweet: PartialTweet)
ts/utils/exported_helpers.ts:196
Function
isWithVideo
(tweet: PartialTweet)
ts/utils/exported_helpers.ts:205
Method
is_gdpr
`true` if archive is a GDPR archive.
ts/TwitterArchive.ts:603
Function
is_group_conversation
True if this conversation is a group conversation.
ts/direct_messages/Conversation.ts:317
Method
is_medias_zipped
()
ts/MediaArchive.ts:285
Method
is_zip_loaded
* `true` if ZIP file is still loaded inside this instance. * Can be freed (to save memory, f.e.) with `.releaseZip()`.
ts/TwitterArchive.ts:560
Method
is_zip_loaded
()
ts/MediaArchive.ts:293
Function
last
Last DM in this conversation. Access to previous messages with LinkedDirectMessage.previous
ts/direct_messages/Conversation.ts:434
Method
last
()
ts/direct_messages/Conversation.ts:698
Method
last_logins
* Contains IP dumps of your last activity on Twitter (using mobile or desktop devices). * * Seems limited up to 7 days from archive creation.
ts/user/UserData.ts:449
Function
length
Number of messages in this conversation
ts/direct_messages/Conversation.ts:418
Method
length
Conversation count.
ts/direct_messages/DMArchive.ts:150
Method
length
* Number of favorites.
ts/tweets/FavoriteArchive.ts:173
Method
length
Number of tweets in this archive.
ts/tweets/TweetArchive.ts:377
Method
list
* List files available on a specific media archive. * * @param of_archive Media archive
ts/MediaArchive.ts:76
Method
lists
* Access to your subscribed and created lists, and the lists you were added into. * * If `.is_gdpr === false`, this container will be contain em
ts/TwitterArchive.ts:719
Method
loadArchive
* Manually set the archive used for a media type. * * The specified {mediaType} can be a reference to a `MediaArchiveType` enum, or a custom med
ts/MediaArchive.ts:324
Method
location
Archive owner profile location.
ts/user/UserData.ts:519
Method
ls
(current_dir_only = true)
ts/reading/FolderArchive.ts:133
Method
ls
(current_dir_only = true)
ts/reading/StreamArchive.ts:154
Method
manifest
* Manifest file, indicating generation date, all available JS files, and more. * * This property is only available for GDPR archives produced by
ts/TwitterArchive.ts:628
Method
medias
* Access to medias stored in this archive, like dm images, tweet medias and profile pictures.
ts/TwitterArchive.ts:752
Method
messages
Access to the `DMArchive` object. Will be undefined if `.is_gdpr === false`.
ts/TwitterArchive.ts:651
Method
moments
* Access to archive Twitter moments. * * If `.is_gdpr === false`, this array will be empty.
ts/TwitterArchive.ts:710
Function
month
Get direct messages from a specific month.
ts/direct_messages/Conversation.ts:73
Method
month
(month: string | number, year: string | number)
ts/tweets/FavoriteArchive.ts:51
Method
monthIterator
* Iterate through tweets, sorted by year and month. * * At each iteration: [year: string, month: string, tweet: PartialTweet] * * @param o
ts/tweets/TweetArchive.ts:460
Method
mutes
* Access to a set of muted user IDs. * * If `.is_gdpr === false`, this container will be empty.
ts/TwitterArchive.ts:701
Method
name
Conversation custom name, if somebody has set it. Could be `undefined`.
ts/direct_messages/Conversation.ts:708
Method
name
Twitter name (also called TN).
ts/user/UserData.ts:514
Method
names
All the custom names given to this conversation.
ts/direct_messages/Conversation.ts:715
Function
numberFileReader
* Read a part of a file (via a file descriptor) into a Node.js buffer, * from position to position+length, into Buffer offset to offset+length
ts/reading/StreamZip.ts:49
Method
ok
()
ts/MediaArchive.ts:475
Function
parseAdDate
(date: string)
ts/utils/exported_helpers.ts:71
Function
parseDeviceDate
(date: string)
ts/utils/exported_helpers.ts:120
Function
participants
Participants IDs
ts/direct_messages/Conversation.ts:301
Method
personalization
"Guessed" things by Twitter about archive owner. * * ```ts * const p13n = archive.user.personalization; * // "Speaked" languages (this is
ts/user/UserData.ts:410
Method
phone_number
* Archive owner phone number (if he registred one), `undefined` otherwise. * Begin by `+<countryCode>`
ts/user/UserData.ts:467
Method
profile_banner_url
Profile banner. Available if `archive.is_gpdr === true` and if archive owner had a banner.
ts/user/UserData.ts:529
Method
profile_img_url
Account profile image (defined only if `archive.is_gdpr === true`).
ts/user/UserData.ts:524
Method
protected_history
History of a user protecting and unprotecting their Tweets, * within the 6 months prior to the date the archive was created
ts/user/UserData.ts:387
Method
raw
* Raw archive object. Can be used to get specific files. * * Returns twitter_archive.
ts/TwitterArchive.ts:637
Method
raw
()
ts/reading/StreamArchive.ts:477
Function
raw_index
Messages sorted by year, month and day, without any other informations
ts/direct_messages/Conversation.ts:408
Method
read
(data: Buffer)
ts/reading/StreamZip.ts:640
Method
read
(data: Buffer)
ts/reading/StreamZip.ts:659
Method
read
(data: Buffer)
ts/reading/StreamZip.ts:673
← previous
next →
201–300 of 335, ranked by callers