rettiwt-api 1.1.8 → 1.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (443) hide show
  1. package/.github/workflows/build-docs.yml +22 -21
  2. package/.github/workflows/publish-to-npm.yml +29 -0
  3. package/README.md +52 -40
  4. package/dist/config/env.d.ts +5 -5
  5. package/dist/config/env.js +8 -8
  6. package/dist/enums/Errors.d.ts +21 -20
  7. package/dist/enums/Errors.js +28 -27
  8. package/dist/enums/Errors.js.map +1 -1
  9. package/dist/enums/HTTP.d.ts +17 -17
  10. package/dist/enums/HTTP.js +22 -22
  11. package/dist/graphql/enums/Errors.d.ts +21 -21
  12. package/dist/graphql/enums/Errors.js +28 -28
  13. package/dist/graphql/queries/RootQuery.d.ts +4 -4
  14. package/dist/graphql/queries/RootQuery.js +77 -77
  15. package/dist/graphql/queries/RootQuery.js.map +1 -1
  16. package/dist/graphql/resolvers/AccountResolver.d.ts +12 -12
  17. package/dist/graphql/resolvers/AccountResolver.js +83 -83
  18. package/dist/graphql/resolvers/ResolverBase.d.ts +16 -16
  19. package/dist/graphql/resolvers/ResolverBase.js +22 -22
  20. package/dist/graphql/resolvers/TweetResolver.d.ts +46 -46
  21. package/dist/graphql/resolvers/TweetResolver.js +311 -311
  22. package/dist/graphql/resolvers/TweetResolver.js.map +1 -1
  23. package/dist/graphql/resolvers/UserResolver.d.ts +48 -48
  24. package/dist/graphql/resolvers/UserResolver.js +333 -333
  25. package/dist/graphql/resolvers/UserResolver.js.map +1 -1
  26. package/dist/graphql/types/Global.d.ts +4 -4
  27. package/dist/graphql/types/Global.js +12 -12
  28. package/dist/graphql/types/TweetTypes.d.ts +4 -4
  29. package/dist/graphql/types/TweetTypes.js +159 -159
  30. package/dist/graphql/types/UserTypes.d.ts +3 -3
  31. package/dist/graphql/types/UserTypes.js +136 -136
  32. package/dist/graphql/types/UserTypes.js.map +1 -1
  33. package/dist/index.d.ts +45 -43
  34. package/dist/index.js +72 -70
  35. package/dist/index.js.map +1 -1
  36. package/dist/models/args/TweetListArgs.d.ts +21 -21
  37. package/dist/models/args/TweetListArgs.js +53 -53
  38. package/dist/models/args/TweetListArgs.js.map +1 -1
  39. package/dist/models/args/UserListArgs.d.ts +21 -21
  40. package/dist/models/args/UserListArgs.js +53 -53
  41. package/dist/models/args/UserListArgs.js.map +1 -1
  42. package/dist/models/auth/AuthCookie.d.ts +21 -21
  43. package/dist/models/auth/AuthCookie.js +32 -32
  44. package/dist/models/data/CursoredData.d.ts +34 -34
  45. package/dist/models/data/CursoredData.js +41 -41
  46. package/dist/models/data/Tweet.d.ts +53 -53
  47. package/dist/models/data/Tweet.js +103 -103
  48. package/dist/models/data/Tweet.js.map +1 -1
  49. package/dist/models/data/User.d.ts +41 -41
  50. package/dist/models/data/User.js +31 -31
  51. package/dist/models/data/User.js.map +1 -1
  52. package/dist/server.d.ts +1 -1
  53. package/dist/server.js +75 -75
  54. package/dist/services/auth/AccountService.d.ts +83 -83
  55. package/dist/services/auth/AccountService.js +411 -411
  56. package/dist/services/auth/AuthService.d.ts +31 -31
  57. package/dist/services/auth/AuthService.js +117 -117
  58. package/dist/services/data/TweetService.d.ts +60 -74
  59. package/dist/services/data/TweetService.js +250 -254
  60. package/dist/services/data/TweetService.js.map +1 -1
  61. package/dist/services/data/UserService.d.ts +71 -87
  62. package/dist/services/data/UserService.js +277 -296
  63. package/dist/services/data/UserService.js.map +1 -1
  64. package/dist/services/helper/Headers.d.ts +19 -19
  65. package/dist/services/helper/Headers.js +61 -61
  66. package/dist/services/helper/Headers.js.map +1 -1
  67. package/dist/services/helper/Parser.d.ts +22 -28
  68. package/dist/services/helper/Parser.js +83 -104
  69. package/dist/services/helper/Parser.js.map +1 -1
  70. package/dist/services/helper/extractors/Tweets.d.ts +23 -32
  71. package/dist/services/helper/extractors/Tweets.js +199 -263
  72. package/dist/services/helper/extractors/Tweets.js.map +1 -1
  73. package/dist/services/helper/extractors/Users.d.ts +17 -26
  74. package/dist/services/helper/extractors/Users.js +150 -202
  75. package/dist/services/helper/extractors/Users.js.map +1 -1
  76. package/dist/services/helper/payloads/LoginFlows.d.ts +77 -77
  77. package/dist/services/helper/payloads/LoginFlows.js +91 -91
  78. package/dist/services/helper/urls/Authentication.d.ts +4 -4
  79. package/dist/services/helper/urls/Authentication.js +10 -10
  80. package/dist/services/util/CacheService.d.ts +33 -33
  81. package/dist/services/util/CacheService.js +95 -95
  82. package/dist/services/util/FetcherService.d.ts +65 -65
  83. package/dist/services/util/FetcherService.js +201 -213
  84. package/dist/services/util/FetcherService.js.map +1 -1
  85. package/dist/types/Args.d.ts +11 -38
  86. package/dist/types/Args.js +3 -4
  87. package/dist/types/Args.js.map +1 -1
  88. package/dist/types/Authentication.d.ts +55 -55
  89. package/dist/types/Authentication.js +5 -5
  90. package/dist/types/Resolvers.d.ts +15 -15
  91. package/dist/types/Resolvers.js +2 -2
  92. package/dist/types/Rettiwt.d.ts +16 -16
  93. package/dist/types/Rettiwt.js +2 -2
  94. package/dist/types/Service.d.ts +22 -22
  95. package/dist/types/Service.js +4 -4
  96. package/dist/types/Tweet.d.ts +46 -46
  97. package/dist/types/Tweet.js +2 -2
  98. package/dist/types/User.d.ts +35 -35
  99. package/dist/types/User.js +2 -2
  100. package/docs/.nojekyll +1 -0
  101. package/docs/assets/highlight.css +64 -0
  102. package/docs/assets/main.js +58 -0
  103. package/docs/assets/search.js +1 -0
  104. package/docs/assets/style.css +1280 -0
  105. package/docs/classes/AccountService.html +286 -0
  106. package/docs/classes/AuthCookie.html +146 -0
  107. package/docs/classes/AuthService.html +147 -0
  108. package/docs/classes/CacheService.html +157 -0
  109. package/docs/classes/Cursor.html +102 -0
  110. package/docs/classes/CursoredData.html +126 -0
  111. package/docs/classes/DataValidationError.html +120 -0
  112. package/docs/classes/FetcherService.html +225 -0
  113. package/docs/classes/Tweet.html +210 -0
  114. package/docs/classes/TweetEntities.html +128 -0
  115. package/docs/classes/TweetFilter.html +223 -0
  116. package/docs/classes/TweetListArgs.html +118 -0
  117. package/docs/classes/TweetService.html +319 -0
  118. package/docs/classes/User.html +230 -0
  119. package/docs/classes/UserListArgs.html +118 -0
  120. package/docs/classes/UserService.html +355 -0
  121. package/docs/enums/HttpMethods.html +74 -0
  122. package/docs/functions/Rettiwt.html +100 -0
  123. package/docs/index.html +159 -0
  124. package/docs/interfaces/IAuthCookie.html +104 -0
  125. package/docs/interfaces/ICursor.html +77 -0
  126. package/docs/interfaces/ICursoredData.html +93 -0
  127. package/docs/interfaces/IDataContext.html +91 -0
  128. package/docs/interfaces/IDataValidationError.html +109 -0
  129. package/docs/interfaces/IListArgs.html +87 -0
  130. package/docs/interfaces/ITweet.html +176 -0
  131. package/docs/interfaces/ITweetEntities.html +104 -0
  132. package/docs/interfaces/ITweetFilter.html +158 -0
  133. package/docs/interfaces/IUser.html +194 -0
  134. package/docs/modules.html +111 -0
  135. package/package.json +4 -3
  136. package/src/enums/Errors.ts +2 -1
  137. package/src/graphql/queries/RootQuery.ts +1 -1
  138. package/src/graphql/resolvers/TweetResolver.ts +12 -59
  139. package/src/graphql/resolvers/UserResolver.ts +4 -4
  140. package/src/graphql/types/UserTypes.ts +2 -2
  141. package/src/index.ts +5 -3
  142. package/src/models/args/TweetListArgs.ts +2 -2
  143. package/src/models/args/UserListArgs.ts +1 -1
  144. package/src/models/data/Tweet.ts +3 -3
  145. package/src/models/data/User.ts +2 -2
  146. package/src/services/data/TweetService.ts +45 -72
  147. package/src/services/data/UserService.ts +61 -71
  148. package/src/services/helper/Headers.ts +34 -34
  149. package/src/services/helper/Parser.ts +5 -26
  150. package/src/services/helper/extractors/Tweets.ts +35 -97
  151. package/src/services/helper/extractors/Users.ts +11 -62
  152. package/src/services/util/FetcherService.ts +15 -22
  153. package/src/types/Args.ts +0 -37
  154. package/Dockerfile +0 -9
  155. package/dist/Test.d.ts +0 -0
  156. package/dist/Test.js +0 -2
  157. package/dist/Test.js.map +0 -1
  158. package/dist/endpoints/Endpoints.d.ts +0 -14
  159. package/dist/endpoints/Endpoints.js +0 -20
  160. package/dist/endpoints/Endpoints.js.map +0 -1
  161. package/dist/endpoints/Url.d.ts +0 -5
  162. package/dist/endpoints/Url.js +0 -12
  163. package/dist/endpoints/Url.js.map +0 -1
  164. package/dist/enums/Endpoints.d.ts +0 -25
  165. package/dist/enums/Endpoints.js +0 -31
  166. package/dist/enums/Endpoints.js.map +0 -1
  167. package/dist/graphql/types/Errors.d.ts +0 -20
  168. package/dist/graphql/types/Errors.js +0 -28
  169. package/dist/graphql/types/Errors.js.map +0 -1
  170. package/dist/middlewares/Authentication.d.ts +0 -0
  171. package/dist/middlewares/Authentication.js +0 -2
  172. package/dist/middlewares/Authentication.js.map +0 -1
  173. package/dist/models/args/TweetFilter.d.ts +0 -59
  174. package/dist/models/args/TweetFilter.js +0 -101
  175. package/dist/models/args/TweetFilter.js.map +0 -1
  176. package/dist/models/data/DataValidationError.d.ts +0 -18
  177. package/dist/models/data/DataValidationError.js +0 -21
  178. package/dist/models/data/DataValidationError.js.map +0 -1
  179. package/dist/models/data/Errors.d.ts +0 -18
  180. package/dist/models/data/Errors.js +0 -21
  181. package/dist/models/data/Errors.js.map +0 -1
  182. package/dist/models/data/Service.d.ts +0 -33
  183. package/dist/models/data/Service.js +0 -41
  184. package/dist/models/data/Service.js.map +0 -1
  185. package/dist/models/errors/DataValidationError.d.ts +0 -20
  186. package/dist/models/errors/DataValidationError.js +0 -23
  187. package/dist/models/errors/DataValidationError.js.map +0 -1
  188. package/dist/models/graphql/Global.d.ts +0 -4
  189. package/dist/models/graphql/Global.js +0 -13
  190. package/dist/models/graphql/Global.js.map +0 -1
  191. package/dist/models/graphql/TweetTypes.d.ts +0 -6
  192. package/dist/models/graphql/TweetTypes.js +0 -156
  193. package/dist/models/graphql/TweetTypes.js.map +0 -1
  194. package/dist/models/graphql/UserTypes.d.ts +0 -3
  195. package/dist/models/graphql/UserTypes.js +0 -139
  196. package/dist/models/graphql/UserTypes.js.map +0 -1
  197. package/dist/models/query/Variables.d.ts +0 -2
  198. package/dist/models/query/Variables.js +0 -10
  199. package/dist/models/query/Variables.js.map +0 -1
  200. package/dist/queries/RootQuery.d.ts +0 -4
  201. package/dist/queries/RootQuery.js +0 -70
  202. package/dist/queries/RootQuery.js.map +0 -1
  203. package/dist/requests/Url.d.ts +0 -5
  204. package/dist/requests/Url.js +0 -12
  205. package/dist/requests/Url.js.map +0 -1
  206. package/dist/requests/payloads/Variables.d.ts +0 -23
  207. package/dist/requests/payloads/Variables.js +0 -24
  208. package/dist/requests/payloads/Variables.js.map +0 -1
  209. package/dist/resolvers/AccountResolver.d.ts +0 -12
  210. package/dist/resolvers/AccountResolver.js +0 -84
  211. package/dist/resolvers/AccountResolver.js.map +0 -1
  212. package/dist/resolvers/ResolverBase.d.ts +0 -5
  213. package/dist/resolvers/ResolverBase.js +0 -11
  214. package/dist/resolvers/ResolverBase.js.map +0 -1
  215. package/dist/resolvers/TweetResolver.d.ts +0 -54
  216. package/dist/resolvers/TweetResolver.js +0 -332
  217. package/dist/resolvers/TweetResolver.js.map +0 -1
  218. package/dist/resolvers/UserResolver.d.ts +0 -38
  219. package/dist/resolvers/UserResolver.js +0 -253
  220. package/dist/resolvers/UserResolver.js.map +0 -1
  221. package/dist/services/AuthService.d.ts +0 -22
  222. package/dist/services/AuthService.js +0 -106
  223. package/dist/services/AuthService.js.map +0 -1
  224. package/dist/services/CacheService.d.ts +0 -30
  225. package/dist/services/CacheService.js +0 -93
  226. package/dist/services/CacheService.js.map +0 -1
  227. package/dist/services/FetcherService.d.ts +0 -61
  228. package/dist/services/FetcherService.js +0 -209
  229. package/dist/services/FetcherService.js.map +0 -1
  230. package/dist/services/accounts/AccountService.d.ts +0 -65
  231. package/dist/services/accounts/AccountService.js +0 -336
  232. package/dist/services/accounts/AccountService.js.map +0 -1
  233. package/dist/services/accounts/LoginFlows.d.ts +0 -77
  234. package/dist/services/accounts/LoginFlows.js +0 -92
  235. package/dist/services/accounts/LoginFlows.js.map +0 -1
  236. package/dist/services/auth/LoginFlows.d.ts +0 -77
  237. package/dist/services/auth/LoginFlows.js +0 -92
  238. package/dist/services/auth/LoginFlows.js.map +0 -1
  239. package/dist/services/data/TrendService.d.ts +0 -17
  240. package/dist/services/data/TrendService.js +0 -116
  241. package/dist/services/data/TrendService.js.map +0 -1
  242. package/dist/services/data/UserAccountService.d.ts +0 -42
  243. package/dist/services/data/UserAccountService.js +0 -239
  244. package/dist/services/data/UserAccountService.js.map +0 -1
  245. package/dist/services/helper/Deserializers.d.ts +0 -19
  246. package/dist/services/helper/Deserializers.js +0 -115
  247. package/dist/services/helper/Deserializers.js.map +0 -1
  248. package/dist/services/helper/Extractors.d.ts +0 -104
  249. package/dist/services/helper/Extractors.js +0 -432
  250. package/dist/services/helper/Extractors.js.map +0 -1
  251. package/dist/services/helper/Urls.d.ts +0 -85
  252. package/dist/services/helper/Urls.js +0 -130
  253. package/dist/services/helper/Urls.js.map +0 -1
  254. package/dist/services/helper/deserializers/Tweets.d.ts +0 -12
  255. package/dist/services/helper/deserializers/Tweets.js +0 -92
  256. package/dist/services/helper/deserializers/Tweets.js.map +0 -1
  257. package/dist/services/helper/deserializers/Users.d.ts +0 -7
  258. package/dist/services/helper/deserializers/Users.js +0 -27
  259. package/dist/services/helper/deserializers/Users.js.map +0 -1
  260. package/dist/services/helper/extractors/Trends.d.ts +0 -3
  261. package/dist/services/helper/extractors/Trends.js +0 -51
  262. package/dist/services/helper/extractors/Trends.js.map +0 -1
  263. package/dist/services/helper/urls/Trends.d.ts +0 -7
  264. package/dist/services/helper/urls/Trends.js +0 -13
  265. package/dist/services/helper/urls/Trends.js.map +0 -1
  266. package/dist/services/helper/urls/Tweets.d.ts +0 -32
  267. package/dist/services/helper/urls/Tweets.js +0 -51
  268. package/dist/services/helper/urls/Tweets.js.map +0 -1
  269. package/dist/services/helper/urls/Users.d.ts +0 -38
  270. package/dist/services/helper/urls/Users.js +0 -76
  271. package/dist/services/helper/urls/Users.js.map +0 -1
  272. package/dist/types/HTTP.d.ts +0 -17
  273. package/dist/types/HTTP.js +0 -23
  274. package/dist/types/HTTP.js.map +0 -1
  275. package/dist/types/Query.d.ts +0 -80
  276. package/dist/types/Query.js +0 -3
  277. package/dist/types/Query.js.map +0 -1
  278. package/dist/types/Trends.d.ts +0 -50
  279. package/dist/types/Trends.js +0 -3
  280. package/dist/types/Trends.js.map +0 -1
  281. package/dist/types/UserAccount.d.ts +0 -19
  282. package/dist/types/UserAccount.js +0 -4
  283. package/dist/types/UserAccount.js.map +0 -1
  284. package/dist/types/args/TweetFilter.d.ts +0 -54
  285. package/dist/types/args/TweetFilter.js +0 -96
  286. package/dist/types/args/TweetFilter.js.map +0 -1
  287. package/dist/types/args/TweetListArg.d.ts +0 -10
  288. package/dist/types/args/TweetListArg.js +0 -42
  289. package/dist/types/args/TweetListArg.js.map +0 -1
  290. package/dist/types/args/TweetListArgs.d.ts +0 -20
  291. package/dist/types/args/TweetListArgs.js +0 -52
  292. package/dist/types/args/TweetListArgs.js.map +0 -1
  293. package/dist/types/args/UserListArgs.d.ts +0 -16
  294. package/dist/types/args/UserListArgs.js +0 -48
  295. package/dist/types/args/UserListArgs.js.map +0 -1
  296. package/dist/types/data/Errors.d.ts +0 -35
  297. package/dist/types/data/Errors.js +0 -45
  298. package/dist/types/data/Errors.js.map +0 -1
  299. package/dist/types/data/Service.d.ts +0 -43
  300. package/dist/types/data/Service.js +0 -22
  301. package/dist/types/data/Service.js.map +0 -1
  302. package/dist/types/data/Tweet.d.ts +0 -98
  303. package/dist/types/data/Tweet.js +0 -4
  304. package/dist/types/data/Tweet.js.map +0 -1
  305. package/dist/types/data/TweetFilter.d.ts +0 -49
  306. package/dist/types/data/TweetFilter.js +0 -63
  307. package/dist/types/data/TweetFilter.js.map +0 -1
  308. package/dist/types/data/User.d.ts +0 -38
  309. package/dist/types/data/User.js +0 -3
  310. package/dist/types/data/User.js.map +0 -1
  311. package/dist/types/graphql/Errors.d.ts +0 -15
  312. package/dist/types/graphql/Errors.js +0 -23
  313. package/dist/types/graphql/Errors.js.map +0 -1
  314. package/dist/types/interfaces/Args.d.ts +0 -38
  315. package/dist/types/interfaces/Args.js +0 -5
  316. package/dist/types/interfaces/Args.js.map +0 -1
  317. package/dist/types/interfaces/Authentication.d.ts +0 -40
  318. package/dist/types/interfaces/Authentication.js +0 -5
  319. package/dist/types/interfaces/Authentication.js.map +0 -1
  320. package/dist/types/interfaces/Resolvers.d.ts +0 -14
  321. package/dist/types/interfaces/Resolvers.js +0 -3
  322. package/dist/types/interfaces/Resolvers.js.map +0 -1
  323. package/dist/types/interfaces/Rettiwt.d.ts +0 -16
  324. package/dist/types/interfaces/Rettiwt.js +0 -3
  325. package/dist/types/interfaces/Rettiwt.js.map +0 -1
  326. package/dist/types/interfaces/Service.d.ts +0 -13
  327. package/dist/types/interfaces/Service.js +0 -3
  328. package/dist/types/interfaces/Service.js.map +0 -1
  329. package/dist/types/interfaces/Services.d.ts +0 -13
  330. package/dist/types/interfaces/Services.js +0 -3
  331. package/dist/types/interfaces/Services.js.map +0 -1
  332. package/dist/types/interfaces/Tweet.d.ts +0 -46
  333. package/dist/types/interfaces/Tweet.js +0 -3
  334. package/dist/types/interfaces/Tweet.js.map +0 -1
  335. package/dist/types/interfaces/TweetFilter.d.ts +0 -0
  336. package/dist/types/interfaces/TweetFilter.js +0 -2
  337. package/dist/types/interfaces/TweetFilter.js.map +0 -1
  338. package/dist/types/interfaces/User.d.ts +0 -35
  339. package/dist/types/interfaces/User.js +0 -3
  340. package/dist/types/interfaces/User.js.map +0 -1
  341. package/dist/types/raw/auth/Cookie.d.ts +0 -16
  342. package/dist/types/raw/auth/Cookie.js +0 -3
  343. package/dist/types/raw/auth/Cookie.js.map +0 -1
  344. package/dist/types/raw/data/tweet/Favouriters.d.ts +0 -164
  345. package/dist/types/raw/data/tweet/Favouriters.js +0 -3
  346. package/dist/types/raw/data/tweet/Favouriters.js.map +0 -1
  347. package/dist/types/raw/data/tweet/Retweeters.d.ts +0 -171
  348. package/dist/types/raw/data/tweet/Retweeters.js +0 -3
  349. package/dist/types/raw/data/tweet/Retweeters.js.map +0 -1
  350. package/dist/types/raw/data/tweet/Tweet.d.ts +0 -746
  351. package/dist/types/raw/data/tweet/Tweet.js +0 -3
  352. package/dist/types/raw/data/tweet/Tweet.js.map +0 -1
  353. package/dist/types/raw/data/tweet/Tweets.d.ts +0 -386
  354. package/dist/types/raw/data/tweet/Tweets.js +0 -3
  355. package/dist/types/raw/data/tweet/Tweets.js.map +0 -1
  356. package/dist/types/raw/data/user/Followers.d.ts +0 -176
  357. package/dist/types/raw/data/user/Followers.js +0 -3
  358. package/dist/types/raw/data/user/Followers.js.map +0 -1
  359. package/dist/types/raw/data/user/Following.d.ts +0 -176
  360. package/dist/types/raw/data/user/Following.js +0 -3
  361. package/dist/types/raw/data/user/Following.js.map +0 -1
  362. package/dist/types/raw/data/user/Likes.d.ts +0 -1059
  363. package/dist/types/raw/data/user/Likes.js +0 -3
  364. package/dist/types/raw/data/user/Likes.js.map +0 -1
  365. package/dist/types/raw/data/user/User.d.ts +0 -117
  366. package/dist/types/raw/data/user/User.js +0 -3
  367. package/dist/types/raw/data/user/User.js.map +0 -1
  368. package/dist/types/raw/general/Trends.d.ts +0 -324
  369. package/dist/types/raw/general/Trends.js +0 -3
  370. package/dist/types/raw/general/Trends.js.map +0 -1
  371. package/dist/types/raw/query/tweet/Details.d.ts +0 -80
  372. package/dist/types/raw/query/tweet/Details.js +0 -5
  373. package/dist/types/raw/query/tweet/Details.js.map +0 -1
  374. package/dist/types/raw/query/tweet/Engagements.d.ts +0 -29
  375. package/dist/types/raw/query/tweet/Engagements.js +0 -3
  376. package/dist/types/raw/query/tweet/Engagements.js.map +0 -1
  377. package/dist/types/raw/query/tweet/Likes.d.ts +0 -29
  378. package/dist/types/raw/query/tweet/Likes.js +0 -3
  379. package/dist/types/raw/query/tweet/Likes.js.map +0 -1
  380. package/dist/types/raw/query/tweet/Retweets.d.ts +0 -29
  381. package/dist/types/raw/query/tweet/Retweets.js +0 -3
  382. package/dist/types/raw/query/tweet/Retweets.js.map +0 -1
  383. package/dist/types/raw/query/tweet/Search.d.ts +0 -40
  384. package/dist/types/raw/query/tweet/Search.js +0 -3
  385. package/dist/types/raw/query/tweet/Search.js.map +0 -1
  386. package/dist/types/raw/query/tweet/TweetDetails.d.ts +0 -34
  387. package/dist/types/raw/query/tweet/TweetDetails.js +0 -5
  388. package/dist/types/raw/query/tweet/TweetDetails.js.map +0 -1
  389. package/dist/types/raw/query/tweet/TweetLike.d.ts +0 -29
  390. package/dist/types/raw/query/tweet/TweetLike.js +0 -3
  391. package/dist/types/raw/query/tweet/TweetLike.js.map +0 -1
  392. package/dist/types/raw/query/tweet/TweetLikes.d.ts +0 -29
  393. package/dist/types/raw/query/tweet/TweetLikes.js +0 -3
  394. package/dist/types/raw/query/tweet/TweetLikes.js.map +0 -1
  395. package/dist/types/raw/query/tweet/TweetRetweets.d.ts +0 -0
  396. package/dist/types/raw/query/tweet/TweetRetweets.js +0 -2
  397. package/dist/types/raw/query/tweet/TweetRetweets.js.map +0 -1
  398. package/dist/types/raw/query/user/Details.d.ts +0 -34
  399. package/dist/types/raw/query/user/Details.js +0 -3
  400. package/dist/types/raw/query/user/Details.js.map +0 -1
  401. package/dist/types/raw/tweet/Favouriters.d.ts +0 -164
  402. package/dist/types/raw/tweet/Favouriters.js +0 -3
  403. package/dist/types/raw/tweet/Favouriters.js.map +0 -1
  404. package/dist/types/raw/tweet/Retweeters.d.ts +0 -171
  405. package/dist/types/raw/tweet/Retweeters.js +0 -3
  406. package/dist/types/raw/tweet/Retweeters.js.map +0 -1
  407. package/dist/types/raw/tweet/Tweet.d.ts +0 -746
  408. package/dist/types/raw/tweet/Tweet.js +0 -3
  409. package/dist/types/raw/tweet/Tweet.js.map +0 -1
  410. package/dist/types/raw/tweet/Tweets.d.ts +0 -386
  411. package/dist/types/raw/tweet/Tweets.js +0 -3
  412. package/dist/types/raw/tweet/Tweets.js.map +0 -1
  413. package/dist/types/raw/user/Followers.d.ts +0 -176
  414. package/dist/types/raw/user/Followers.js +0 -3
  415. package/dist/types/raw/user/Followers.js.map +0 -1
  416. package/dist/types/raw/user/Following.d.ts +0 -176
  417. package/dist/types/raw/user/Following.js +0 -3
  418. package/dist/types/raw/user/Following.js.map +0 -1
  419. package/dist/types/raw/user/Likes.d.ts +0 -1059
  420. package/dist/types/raw/user/Likes.js +0 -3
  421. package/dist/types/raw/user/Likes.js.map +0 -1
  422. package/dist/types/raw/user/Tweets.d.ts +0 -1512
  423. package/dist/types/raw/user/Tweets.js +0 -3
  424. package/dist/types/raw/user/Tweets.js.map +0 -1
  425. package/dist/types/raw/user/User.d.ts +0 -117
  426. package/dist/types/raw/user/User.js +0 -3
  427. package/dist/types/raw/user/User.js.map +0 -1
  428. package/dist/types/services/args/TweetFilter.d.ts +0 -50
  429. package/dist/types/services/args/TweetFilter.js +0 -76
  430. package/dist/types/services/args/TweetFilter.js.map +0 -1
  431. package/src/models/args/TweetFilter.ts +0 -119
  432. package/src/models/errors/DataValidationError.ts +0 -29
  433. package/src/services/helper/urls/Tweets.ts +0 -46
  434. package/src/services/helper/urls/Users.ts +0 -78
  435. package/src/types/raw/tweet/Favouriters.ts +0 -193
  436. package/src/types/raw/tweet/Retweeters.ts +0 -201
  437. package/src/types/raw/tweet/Tweet.ts +0 -882
  438. package/src/types/raw/tweet/Tweets.ts +0 -444
  439. package/src/types/raw/user/Followers.ts +0 -208
  440. package/src/types/raw/user/Following.ts +0 -208
  441. package/src/types/raw/user/Likes.ts +0 -1247
  442. package/src/types/raw/user/Tweets.ts +0 -1747
  443. package/src/types/raw/user/User.ts +0 -135
package/docs/functions/Rettiwt.html ADDED
@@ -0,0 +1,100 @@
1
+ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Rettiwt | rettiwt-api</title><meta name="description" content="Documentation for rettiwt-api"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
2
+ <div class="tsd-toolbar-contents container">
3
+ <div class="table-cell" id="tsd-search" data-base="..">
4
+ <div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
5
+ <div class="field">
6
+ <div id="tsd-toolbar-links"></div></div>
7
+ <ul class="results">
8
+ <li class="state loading">Preparing search index...</li>
9
+ <li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">rettiwt-api</a></div>
10
+ <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
11
+ <div class="container container-main">
12
+ <div class="col-8 col-content">
13
+ <div class="tsd-page-title">
14
+ <ul class="tsd-breadcrumb">
15
+ <li><a href="../modules.html">rettiwt-api</a></li>
16
+ <li><a href="Rettiwt.html">Rettiwt</a></li></ul>
17
+ <h1>Function Rettiwt</h1></div>
18
+ <section class="tsd-panel">
19
+ <ul class="tsd-signatures tsd-kind-function">
20
+ <li class="tsd-signature tsd-anchor-link" id="Rettiwt">Rettiwt<span class="tsd-signature-symbol">(</span>cookie<span class="tsd-signature-symbol">?: </span><a href="../interfaces/IAuthCookie.html" class="tsd-signature-type" data-tsd-kind="Interface">IAuthCookie</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span>    </span>account<span class="tsd-signature-symbol">: </span><a href="../classes/AccountService.html" class="tsd-signature-type" data-tsd-kind="Class">AccountService</a><span class="tsd-signature-symbol">; </span><br/><span>    </span>tweets<span class="tsd-signature-symbol">: </span><a href="../classes/TweetService.html" class="tsd-signature-type" data-tsd-kind="Class">TweetService</a><span class="tsd-signature-symbol">; </span><br/><span>    </span>users<span class="tsd-signature-symbol">: </span><a href="../classes/UserService.html" class="tsd-signature-type" data-tsd-kind="Class">UserService</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><a href="#Rettiwt" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" id="icon-anchor-c"></path></svg></a></li>
21
+ <li class="tsd-description">
22
+ <div class="tsd-comment tsd-typography"><p>The instance for fetching data from Twitter.</p>
23
+
24
+ <h3>Returns</h3><p>The API for fetching user and tweet data.</p>
25
+
26
+ <h3>Remarks</h3><p>The cookie can be obtained by using <a href="../classes/AccountService.html#login">login</a> method.
27
+ To use the <a href="../classes/AccountService.html#login">login</a> method, create a <a href="Rettiwt.html">Rettiwt</a> instance without passing any cookie .
28
+ Then use the <a href="../classes/AccountService.html#login">login</a> method of <a href="../classes/AccountService.html">AccountService</a> to get the cookie.</p>
29
+ </div>
30
+ <div class="tsd-parameters">
31
+ <h4 class="tsd-parameters-title">Parameters</h4>
32
+ <ul class="tsd-parameter-list">
33
+ <li>
34
+ <h5><code class="tsd-tag ts-flagOptional">Optional</code> cookie: <a href="../interfaces/IAuthCookie.html" class="tsd-signature-type" data-tsd-kind="Interface">IAuthCookie</a></h5>
35
+ <div class="tsd-comment tsd-typography"><p>The cookie to use to fetch data.</p>
36
+ </div></li></ul></div>
37
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span><br/><span>    </span>account<span class="tsd-signature-symbol">: </span><a href="../classes/AccountService.html" class="tsd-signature-type" data-tsd-kind="Class">AccountService</a><span class="tsd-signature-symbol">; </span><br/><span>    </span>tweets<span class="tsd-signature-symbol">: </span><a href="../classes/TweetService.html" class="tsd-signature-type" data-tsd-kind="Class">TweetService</a><span class="tsd-signature-symbol">; </span><br/><span>    </span>users<span class="tsd-signature-symbol">: </span><a href="../classes/UserService.html" class="tsd-signature-type" data-tsd-kind="Class">UserService</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h4>
38
+ <ul class="tsd-parameters">
39
+ <li class="tsd-parameter">
40
+ <h5>account<span class="tsd-signature-symbol">: </span><a href="../classes/AccountService.html" class="tsd-signature-type" data-tsd-kind="Class">AccountService</a></h5></li>
41
+ <li class="tsd-parameter">
42
+ <h5>tweets<span class="tsd-signature-symbol">: </span><a href="../classes/TweetService.html" class="tsd-signature-type" data-tsd-kind="Class">TweetService</a></h5></li>
43
+ <li class="tsd-parameter">
44
+ <h5>users<span class="tsd-signature-symbol">: </span><a href="../classes/UserService.html" class="tsd-signature-type" data-tsd-kind="Class">UserService</a></h5></li></ul><aside class="tsd-sources">
45
+ <ul>
46
+ <li>Defined in <a href="https://github.com/Rishikant181/Rettiwt-API/blob/e11e4bf/src/index.ts#L26">src/index.ts:26</a></li></ul></aside></li></ul></section></div>
47
+ <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
48
+ <div class="tsd-navigation settings">
49
+ <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
50
+ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Settings</h3></summary>
51
+ <div class="tsd-accordion-details">
52
+ <div class="tsd-filter-visibility">
53
+ <h4 class="uppercase">Member Visibility</h4><form>
54
+ <ul id="tsd-filter-options">
55
+ <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li>
56
+ <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li>
57
+ <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li>
58
+ <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div>
59
+ <div class="tsd-theme-toggle">
60
+ <h4 class="uppercase">Theme</h4><select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
61
+ <nav class="tsd-navigation primary">
62
+ <details class="tsd-index-accordion" open><summary class="tsd-accordion-summary">
63
+ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Modules</h3></summary>
64
+ <div class="tsd-accordion-details">
65
+ <ul>
66
+ <li><a href="../modules.html">rettiwt-<wbr/>api</a>
67
+ <ul></ul></li></ul></div></details></nav>
68
+ <nav class="tsd-navigation secondary menu-sticky">
69
+ <ul>
70
+ <li class="tsd-kind-enum"><a href="../enums/HttpMethods.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-enum)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-8-path"></rect><path d="M9.45 16V7.24H14.49V8.224H10.518V10.936H14.07V11.908H10.518V15.016H14.49V16H9.45Z" fill="var(--color-text)" id="icon-8-text"></path></svg>Http<wbr/>Methods</a></li>
71
+ <li class="tsd-kind-class"><a href="../classes/AccountService.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-128-path"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)" id="icon-128-text"></path></svg>Account<wbr/>Service</a></li>
72
+ <li class="tsd-kind-class"><a href="../classes/AuthCookie.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Auth<wbr/>Cookie</a></li>
73
+ <li class="tsd-kind-class"><a href="../classes/AuthService.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Auth<wbr/>Service</a></li>
74
+ <li class="tsd-kind-class"><a href="../classes/CacheService.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Cache<wbr/>Service</a></li>
75
+ <li class="tsd-kind-class"><a href="../classes/Cursor.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Cursor</a></li>
76
+ <li class="tsd-kind-class"><a href="../classes/CursoredData.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Cursored<wbr/>Data</a></li>
77
+ <li class="tsd-kind-class tsd-is-external"><a href="../classes/DataValidationError.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Data<wbr/>Validation<wbr/>Error</a></li>
78
+ <li class="tsd-kind-class"><a href="../classes/FetcherService.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Fetcher<wbr/>Service</a></li>
79
+ <li class="tsd-kind-class"><a href="../classes/Tweet.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Tweet</a></li>
80
+ <li class="tsd-kind-class"><a href="../classes/TweetEntities.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Tweet<wbr/>Entities</a></li>
81
+ <li class="tsd-kind-class tsd-is-external"><a href="../classes/TweetFilter.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Tweet<wbr/>Filter</a></li>
82
+ <li class="tsd-kind-class"><a href="../classes/TweetListArgs.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Tweet<wbr/>List<wbr/>Args</a></li>
83
+ <li class="tsd-kind-class"><a href="../classes/TweetService.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Tweet<wbr/>Service</a></li>
84
+ <li class="tsd-kind-class"><a href="../classes/User.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>User</a></li>
85
+ <li class="tsd-kind-class"><a href="../classes/UserListArgs.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>User<wbr/>List<wbr/>Args</a></li>
86
+ <li class="tsd-kind-class"><a href="../classes/UserService.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>User<wbr/>Service</a></li>
87
+ <li class="tsd-kind-interface"><a href="../interfaces/IAuthCookie.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-256-path"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)" id="icon-256-text"></path></svg>IAuth<wbr/>Cookie</a></li>
88
+ <li class="tsd-kind-interface"><a href="../interfaces/ICursor.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>ICursor</a></li>
89
+ <li class="tsd-kind-interface"><a href="../interfaces/ICursoredData.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>ICursored<wbr/>Data</a></li>
90
+ <li class="tsd-kind-interface"><a href="../interfaces/IDataContext.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>IData<wbr/>Context</a></li>
91
+ <li class="tsd-kind-interface tsd-is-external"><a href="../interfaces/IDataValidationError.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>IData<wbr/>Validation<wbr/>Error</a></li>
92
+ <li class="tsd-kind-interface"><a href="../interfaces/IListArgs.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>IList<wbr/>Args</a></li>
93
+ <li class="tsd-kind-interface"><a href="../interfaces/ITweet.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>ITweet</a></li>
94
+ <li class="tsd-kind-interface"><a href="../interfaces/ITweetEntities.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>ITweet<wbr/>Entities</a></li>
95
+ <li class="tsd-kind-interface tsd-is-external"><a href="../interfaces/ITweetFilter.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>ITweet<wbr/>Filter</a></li>
96
+ <li class="tsd-kind-interface"><a href="../interfaces/IUser.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>IUser</a></li>
97
+ <li class="current tsd-kind-function"><a href="Rettiwt.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-64-path"></rect><path d="M9.39 16V7.24H14.55V8.224H10.446V11.128H14.238V12.112H10.47V16H9.39Z" fill="var(--color-text)" id="icon-64-text"></path></svg>Rettiwt</a></li></ul></nav></div></div>
98
+ <div class="container tsd-generator">
99
+ <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
100
+ <div class="overlay"></div><script src="../assets/main.js"></script></body></html>
package/docs/index.html ADDED
@@ -0,0 +1,159 @@
1
+ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>rettiwt-api</title><meta name="description" content="Documentation for rettiwt-api"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script async src="assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
2
+ <div class="tsd-toolbar-contents container">
3
+ <div class="table-cell" id="tsd-search" data-base=".">
4
+ <div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
5
+ <div class="field">
6
+ <div id="tsd-toolbar-links"></div></div>
7
+ <ul class="results">
8
+ <li class="state loading">Preparing search index...</li>
9
+ <li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">rettiwt-api</a></div>
10
+ <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
11
+ <div class="container container-main">
12
+ <div class="col-8 col-content">
13
+ <div class="tsd-page-title">
14
+ <h2>rettiwt-api</h2></div>
15
+ <div class="tsd-panel tsd-typography">
16
+ <a href="#rettiwt-api" id="rettiwt-api" style="color: inherit; text-decoration: none;">
17
+ <h1>Rettiwt-API</h1>
18
+ </a>
19
+ <p>An API for fetching data from TwitterAPI, without any rate limits!</p>
20
+
21
+ <a href="#this-api-is-not-a-replacement-of-official-twitter-api-since-it-does-not-scale" id="this-api-is-not-a-replacement-of-official-twitter-api-since-it-does-not-scale" style="color: inherit; text-decoration: none;">
22
+ <h4><strong>This API is not a replacement of official Twitter API, since it does not scale</strong></h4>
23
+ </a>
24
+
25
+ <a href="#it-works-well-for-small-applications-like-the-one-side-project-you-started-and-are-never-gonna-finish" id="it-works-well-for-small-applications-like-the-one-side-project-you-started-and-are-never-gonna-finish" style="color: inherit; text-decoration: none;">
26
+ <h4><strong>It works well for small applications like the one side project you started and are never gonna finish</strong></h4>
27
+ </a>
28
+
29
+ <a href="#if-you-want-something-that-will-scale-as-you-application-grows-twitter-api-is-the-way-to-go" id="if-you-want-something-that-will-scale-as-you-application-grows-twitter-api-is-the-way-to-go" style="color: inherit; text-decoration: none;">
30
+ <h4><strong>If you want something that will scale as you application grows, Twitter API is the way to go</strong></h4>
31
+ </a>
32
+
33
+ <a href="#the-api-can-either-be-used-as-a-graphql-server-or-as-a-standalone-npm-library" id="the-api-can-either-be-used-as-a-graphql-server-or-as-a-standalone-npm-library" style="color: inherit; text-decoration: none;">
34
+ <h4><strong>The API can either be used as a GraphQL Server or as a standalone npm library</strong></h4>
35
+ </a>
36
+
37
+ <a href="#for-complete-documentation-and-api-reference-head-over-to-the-documentation" id="for-complete-documentation-and-api-reference-head-over-to-the-documentation" style="color: inherit; text-decoration: none;">
38
+ <h4><strong>For complete documentation and API reference, head over to the <a href="https://rishikant181.github.io/Rettiwt-API/">documentation</a></strong></h4>
39
+ </a>
40
+
41
+ <a href="#1-graphql-server" id="1-graphql-server" style="color: inherit; text-decoration: none;">
42
+ <h2>1. GraphQL Server</h2>
43
+ </a>
44
+ <p>Using the API as a GraphQL enables complex nested queries to fetch data from twitter.<br>To use the API as a server,</p>
45
+ <ol>
46
+ <li>Clone the repo&#39;s release branch</li>
47
+ <li>Build the project using &#39;npm run build&#39;</li>
48
+ <li>Set the environment variables:<ul>
49
+ <li>APP_PORT -&gt; The port number where the server will listen to</li>
50
+ <li>DEVELOPMENT -&gt; Whether to run the server in development mode or not</li>
51
+ </ul>
52
+ </li>
53
+ <li>Start the server using &#39;npm run start&#39;</li>
54
+ <li>Make graphql requests to server listening on localhost:port/graphql</li>
55
+ </ol>
56
+ <p><strong>You can go to localhost:port/graphql to see the graphql schema</strong></p>
57
+
58
+ <a href="#2-npm-package" id="2-npm-package" style="color: inherit; text-decoration: none;">
59
+ <h2>2. NPM Package</h2>
60
+ </a>
61
+ <p>The API can also be used as a standalone npm package.<br>The limitation is that, large number of data cannot be fetched automatically, and the data needs to fetched in batches, by using cursors.
62
+ Further nested queries are not possible.<br>To use the API as an npm package,</p>
63
+ <ol>
64
+ <li>In your node project, install the package using &#39;npm install --save rettiwt-api&#39;.</li>
65
+ <li>import { Rettiwt } from &#39;rettiwt-api&#39;.<pre><code><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">rettiwt</span><span class="hl-1"> = </span><span class="hl-3">Rettiwt</span><span class="hl-1">({</span><br/><span class="hl-1"> &lt;put your authentication tokens here. For </span><span class="hl-4">details</span><span class="hl-1">, refer to section below&gt;</span><br/><span class="hl-1">}).</span>
66
+ </code></pre>
67
+ </li>
68
+ <li>Use the created <a href="https://rishikant181.github.io/Rettiwt-API/functions/Rettiwt.html">Rettiwt</a> instance to fetch data from Twitter.</li>
69
+ </ol>
70
+ <p><strong>The authentication tokens can be generated in the following way:</strong></p>
71
+
72
+ <a href="#a-graphql-server" id="a-graphql-server" style="color: inherit; text-decoration: none;">
73
+ <h4>A. GraphQL Server:</h4>
74
+ </a>
75
+ <ol>
76
+ <li>Make the following query to the GraphQL server:</li>
77
+ </ol>
78
+ <pre><code><span class="hl-1"> </span><span class="hl-4">query</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-3">Login</span><span class="hl-1">(</span><span class="hl-4">email</span><span class="hl-1">: </span><span class="hl-5">&quot;your_twitter_email&quot;</span><span class="hl-1">, </span><span class="hl-4">userName</span><span class="hl-1">: </span><span class="hl-5">&quot;your_twitter_username&quot;</span><span class="hl-1">, </span><span class="hl-4">password</span><span class="hl-1">: </span><span class="hl-5">&quot;your_twitter_password&quot;</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-4">auth_token</span><br/><span class="hl-1"> </span><span class="hl-4">ct0</span><br/><span class="hl-1"> </span><span class="hl-4">kdt</span><br/><span class="hl-1"> </span><span class="hl-4">twid</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> }</span>
79
+ </code></pre>
80
+ <ol>
81
+ <li>This will give you 4 tokens: &#39;auth_token&#39;, &#39;ct0&#39;, &#39;kdt&#39; and &#39;twid&#39;.</li>
82
+ <li>Pass the four tokens in the headers while making any request made to the GraphQL server for fetching data.</li>
83
+ </ol>
84
+
85
+ <a href="#b-npm-library" id="b-npm-library" style="color: inherit; text-decoration: none;">
86
+ <h4>B. NPM Library:</h4>
87
+ </a>
88
+ <ol>
89
+ <li>Use the <a href="https://rishikant181.github.io/Rettiwt-API/classes/AccountService.html#login">Rettiwt().account.login</a> method to get back 4 tokens: &#39;auth_token&#39;, &#39;ct0&#39;, &#39;kdt&#39; and &#39;twid&#39;.</li>
90
+ <li>Use these four tokens to initialize a new <a href="https://rishikant181.github.io/Rettiwt-API/functions/Rettiwt.html">Rettiwt</a> instance as follows:</li>
91
+ </ol>
92
+ <pre><code><span class="hl-1"> </span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">rettiwt</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">Rettiwt</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-4">auth_token:</span><span class="hl-1"> </span><span class="hl-5">&quot;received_auth_token&quot;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">ct0:</span><span class="hl-1"> </span><span class="hl-5">&quot;received_ct0_token&quot;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">kdt:</span><span class="hl-1"> </span><span class="hl-5">&quot;received_kdt_token&quot;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-4">twid:</span><span class="hl-1"> </span><span class="hl-5">&quot;received_twid_token&quot;</span><br/><span class="hl-1"> });</span>
93
+ </code></pre>
94
+ <ol start="3">
95
+ <li>Use the created <a href="https://rishikant181.github.io/Rettiwt-API/functions/Rettiwt.html">Rettiwt</a> instance to fetch data.</li>
96
+ </ol>
97
+
98
+ <a href="#due-to-changes-in-twitter-api-all-methods-now-require-logging-in-and-using-the-tokens-for-authentication" id="due-to-changes-in-twitter-api-all-methods-now-require-logging-in-and-using-the-tokens-for-authentication" style="color: inherit; text-decoration: none;">
99
+ <h3><strong>Due to changes in Twitter API, all methods now require logging in and using the tokens for authentication</strong></h3>
100
+ </a>
101
+
102
+ <a href="#i39m-not-responsible-if-you-get-your-twitter-account-banned" id="i39m-not-responsible-if-you-get-your-twitter-account-banned" style="color: inherit; text-decoration: none;">
103
+ <h3><strong>I&#39;M NOT RESPONSIBLE IF YOU GET YOUR TWITTER ACCOUNT BANNED!</strong></h3>
104
+ </a>
105
+ </div></div>
106
+ <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
107
+ <div class="tsd-navigation settings">
108
+ <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
109
+ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Settings</h3></summary>
110
+ <div class="tsd-accordion-details">
111
+ <div class="tsd-filter-visibility">
112
+ <h4 class="uppercase">Member Visibility</h4><form>
113
+ <ul id="tsd-filter-options">
114
+ <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li>
115
+ <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li>
116
+ <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li>
117
+ <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div>
118
+ <div class="tsd-theme-toggle">
119
+ <h4 class="uppercase">Theme</h4><select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
120
+ <nav class="tsd-navigation primary">
121
+ <details class="tsd-index-accordion" open><summary class="tsd-accordion-summary">
122
+ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Modules</h3></summary>
123
+ <div class="tsd-accordion-details">
124
+ <ul>
125
+ <li class="current selected"><a href="modules.html">rettiwt-<wbr/>api</a>
126
+ <ul></ul></li></ul></div></details></nav>
127
+ <nav class="tsd-navigation secondary menu-sticky">
128
+ <ul>
129
+ <li class="tsd-kind-enum"><a href="enums/HttpMethods.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-enum)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-8-path"></rect><path d="M9.45 16V7.24H14.49V8.224H10.518V10.936H14.07V11.908H10.518V15.016H14.49V16H9.45Z" fill="var(--color-text)" id="icon-8-text"></path></svg>Http<wbr/>Methods</a></li>
130
+ <li class="tsd-kind-class"><a href="classes/AccountService.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-128-path"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)" id="icon-128-text"></path></svg>Account<wbr/>Service</a></li>
131
+ <li class="tsd-kind-class"><a href="classes/AuthCookie.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Auth<wbr/>Cookie</a></li>
132
+ <li class="tsd-kind-class"><a href="classes/AuthService.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Auth<wbr/>Service</a></li>
133
+ <li class="tsd-kind-class"><a href="classes/CacheService.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Cache<wbr/>Service</a></li>
134
+ <li class="tsd-kind-class"><a href="classes/Cursor.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Cursor</a></li>
135
+ <li class="tsd-kind-class"><a href="classes/CursoredData.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Cursored<wbr/>Data</a></li>
136
+ <li class="tsd-kind-class tsd-is-external"><a href="classes/DataValidationError.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Data<wbr/>Validation<wbr/>Error</a></li>
137
+ <li class="tsd-kind-class"><a href="classes/FetcherService.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Fetcher<wbr/>Service</a></li>
138
+ <li class="tsd-kind-class"><a href="classes/Tweet.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Tweet</a></li>
139
+ <li class="tsd-kind-class"><a href="classes/TweetEntities.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Tweet<wbr/>Entities</a></li>
140
+ <li class="tsd-kind-class tsd-is-external"><a href="classes/TweetFilter.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Tweet<wbr/>Filter</a></li>
141
+ <li class="tsd-kind-class"><a href="classes/TweetListArgs.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Tweet<wbr/>List<wbr/>Args</a></li>
142
+ <li class="tsd-kind-class"><a href="classes/TweetService.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Tweet<wbr/>Service</a></li>
143
+ <li class="tsd-kind-class"><a href="classes/User.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>User</a></li>
144
+ <li class="tsd-kind-class"><a href="classes/UserListArgs.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>User<wbr/>List<wbr/>Args</a></li>
145
+ <li class="tsd-kind-class"><a href="classes/UserService.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>User<wbr/>Service</a></li>
146
+ <li class="tsd-kind-interface"><a href="interfaces/IAuthCookie.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-256-path"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)" id="icon-256-text"></path></svg>IAuth<wbr/>Cookie</a></li>
147
+ <li class="tsd-kind-interface"><a href="interfaces/ICursor.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>ICursor</a></li>
148
+ <li class="tsd-kind-interface"><a href="interfaces/ICursoredData.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>ICursored<wbr/>Data</a></li>
149
+ <li class="tsd-kind-interface"><a href="interfaces/IDataContext.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>IData<wbr/>Context</a></li>
150
+ <li class="tsd-kind-interface tsd-is-external"><a href="interfaces/IDataValidationError.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>IData<wbr/>Validation<wbr/>Error</a></li>
151
+ <li class="tsd-kind-interface"><a href="interfaces/IListArgs.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>IList<wbr/>Args</a></li>
152
+ <li class="tsd-kind-interface"><a href="interfaces/ITweet.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>ITweet</a></li>
153
+ <li class="tsd-kind-interface"><a href="interfaces/ITweetEntities.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>ITweet<wbr/>Entities</a></li>
154
+ <li class="tsd-kind-interface tsd-is-external"><a href="interfaces/ITweetFilter.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>ITweet<wbr/>Filter</a></li>
155
+ <li class="tsd-kind-interface"><a href="interfaces/IUser.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>IUser</a></li>
156
+ <li class="tsd-kind-function"><a href="functions/Rettiwt.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-64-path"></rect><path d="M9.39 16V7.24H14.55V8.224H10.446V11.128H14.238V12.112H10.47V16H9.39Z" fill="var(--color-text)" id="icon-64-text"></path></svg>Rettiwt</a></li></ul></nav></div></div>
157
+ <div class="container tsd-generator">
158
+ <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
159
+ <div class="overlay"></div><script src="assets/main.js"></script></body></html>
package/docs/interfaces/IAuthCookie.html ADDED
@@ -0,0 +1,104 @@
1
+ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>IAuthCookie | rettiwt-api</title><meta name="description" content="Documentation for rettiwt-api"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
2
+ <div class="tsd-toolbar-contents container">
3
+ <div class="table-cell" id="tsd-search" data-base="..">
4
+ <div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
5
+ <div class="field">
6
+ <div id="tsd-toolbar-links"></div></div>
7
+ <ul class="results">
8
+ <li class="state loading">Preparing search index...</li>
9
+ <li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">rettiwt-api</a></div>
10
+ <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
11
+ <div class="container container-main">
12
+ <div class="col-8 col-content">
13
+ <div class="tsd-page-title">
14
+ <ul class="tsd-breadcrumb">
15
+ <li><a href="../modules.html">rettiwt-api</a></li>
16
+ <li><a href="IAuthCookie.html">IAuthCookie</a></li></ul>
17
+ <h1>Interface IAuthCookie</h1></div>
18
+ <section class="tsd-panel tsd-comment">
19
+ <div class="tsd-comment tsd-typography"><p>The cookie containing the tokens that are used to authenticate against Twitter.</p>
20
+ </div></section>
21
+ <section class="tsd-panel tsd-hierarchy">
22
+ <h4>Hierarchy</h4>
23
+ <ul class="tsd-hierarchy">
24
+ <li><span class="target">IAuthCookie</span></li></ul></section>
25
+ <section class="tsd-panel">
26
+ <h4>Implemented by</h4>
27
+ <ul class="tsd-hierarchy">
28
+ <li><a href="../classes/AuthCookie.html" class="tsd-signature-type" data-tsd-kind="Class">AuthCookie</a></li></ul></section><aside class="tsd-sources">
29
+ <ul>
30
+ <li>Defined in <a href="https://github.com/Rishikant181/Rettiwt-API/blob/e11e4bf/src/types/Authentication.ts#L51">src/types/Authentication.ts:51</a></li></ul></aside>
31
+ <section class="tsd-panel-group tsd-index-group">
32
+ <section class="tsd-panel tsd-index-panel">
33
+ <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
34
+ <h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex=0><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M1.5 5.50969L8 11.6609L14.5 5.50969L12.5466 3.66086L8 7.96494L3.45341 3.66086L1.5 5.50969Z" fill="var(--color-text)"></path></svg> Index</h5></summary>
35
+ <div class="tsd-accordion-details">
36
+ <section class="tsd-index-section">
37
+ <h3 class="tsd-index-heading">Properties</h3>
38
+ <div class="tsd-index-list"><a href="IAuthCookie.html#auth_token" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)" id="icon-1024-text"></path></svg><span>auth_<wbr/>token</span></a>
39
+ <a href="IAuthCookie.html#ct0" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>ct0</span></a>
40
+ <a href="IAuthCookie.html#kdt" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>kdt</span></a>
41
+ <a href="IAuthCookie.html#twid" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>twid</span></a>
42
+ </div></section></div></details></section></section>
43
+ <section class="tsd-panel-group tsd-member-group">
44
+ <h2>Properties</h2>
45
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="auth_token" class="tsd-anchor"></a>
46
+ <h3 class="tsd-anchor-link"><span>auth_<wbr/>token</span><a href="#auth_token" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" id="icon-anchor-c"></path></svg></a></h3>
47
+ <div class="tsd-signature">auth_<wbr/>token<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
48
+ <div class="tsd-comment tsd-typography"><p>The authentication token used while logging in to the account.</p>
49
+ </div><aside class="tsd-sources">
50
+ <ul>
51
+ <li>Defined in <a href="https://github.com/Rishikant181/Rettiwt-API/blob/e11e4bf/src/types/Authentication.ts#L62">src/types/Authentication.ts:62</a></li></ul></aside></section>
52
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="ct0" class="tsd-anchor"></a>
53
+ <h3 class="tsd-anchor-link"><span>ct0</span><a href="#ct0" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
54
+ <div class="tsd-signature">ct0<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
55
+ <div class="tsd-comment tsd-typography"><p>The CSRF token of the session.</p>
56
+ </div><aside class="tsd-sources">
57
+ <ul>
58
+ <li>Defined in <a href="https://github.com/Rishikant181/Rettiwt-API/blob/e11e4bf/src/types/Authentication.ts#L59">src/types/Authentication.ts:59</a></li></ul></aside></section>
59
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="kdt" class="tsd-anchor"></a>
60
+ <h3 class="tsd-anchor-link"><span>kdt</span><a href="#kdt" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
61
+ <div class="tsd-signature">kdt<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
62
+ <div class="tsd-comment tsd-typography"><p>Token used to authenticate a device.</p>
63
+ </div><aside class="tsd-sources">
64
+ <ul>
65
+ <li>Defined in <a href="https://github.com/Rishikant181/Rettiwt-API/blob/e11e4bf/src/types/Authentication.ts#L53">src/types/Authentication.ts:53</a></li></ul></aside></section>
66
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="twid" class="tsd-anchor"></a>
67
+ <h3 class="tsd-anchor-link"><span>twid</span><a href="#twid" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
68
+ <div class="tsd-signature">twid<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
69
+ <div class="tsd-comment tsd-typography"><p>Token used to authenticate a user using a Twitter ID.</p>
70
+ </div><aside class="tsd-sources">
71
+ <ul>
72
+ <li>Defined in <a href="https://github.com/Rishikant181/Rettiwt-API/blob/e11e4bf/src/types/Authentication.ts#L56">src/types/Authentication.ts:56</a></li></ul></aside></section></section></div>
73
+ <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
74
+ <div class="tsd-navigation settings">
75
+ <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
76
+ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Settings</h3></summary>
77
+ <div class="tsd-accordion-details">
78
+ <div class="tsd-filter-visibility">
79
+ <h4 class="uppercase">Member Visibility</h4><form>
80
+ <ul id="tsd-filter-options">
81
+ <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li>
82
+ <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li>
83
+ <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li>
84
+ <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div>
85
+ <div class="tsd-theme-toggle">
86
+ <h4 class="uppercase">Theme</h4><select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
87
+ <nav class="tsd-navigation primary">
88
+ <details class="tsd-index-accordion" open><summary class="tsd-accordion-summary">
89
+ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Modules</h3></summary>
90
+ <div class="tsd-accordion-details">
91
+ <ul>
92
+ <li><a href="../modules.html">rettiwt-<wbr/>api</a>
93
+ <ul></ul></li></ul></div></details></nav>
94
+ <nav class="tsd-navigation secondary menu-sticky">
95
+ <ul>
96
+ <li class="current tsd-kind-interface"><a href="IAuthCookie.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-256-path"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)" id="icon-256-text"></path></svg><span>IAuth<wbr/>Cookie</span></a>
97
+ <ul>
98
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="IAuthCookie.html#auth_token" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>auth_<wbr/>token</a></li>
99
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="IAuthCookie.html#ct0" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>ct0</a></li>
100
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="IAuthCookie.html#kdt" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>kdt</a></li>
101
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="IAuthCookie.html#twid" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>twid</a></li></ul></li></ul></nav></div></div>
102
+ <div class="container tsd-generator">
103
+ <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
104
+ <div class="overlay"></div><script src="../assets/main.js"></script></body></html>
package/docs/interfaces/ICursor.html ADDED
@@ -0,0 +1,77 @@
1
+ <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ICursor | rettiwt-api</title><meta name="description" content="Documentation for rettiwt-api"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
2
+ <div class="tsd-toolbar-contents container">
3
+ <div class="table-cell" id="tsd-search" data-base="..">
4
+ <div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
5
+ <div class="field">
6
+ <div id="tsd-toolbar-links"></div></div>
7
+ <ul class="results">
8
+ <li class="state loading">Preparing search index...</li>
9
+ <li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">rettiwt-api</a></div>
10
+ <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
11
+ <div class="container container-main">
12
+ <div class="col-8 col-content">
13
+ <div class="tsd-page-title">
14
+ <ul class="tsd-breadcrumb">
15
+ <li><a href="../modules.html">rettiwt-api</a></li>
16
+ <li><a href="ICursor.html">ICursor</a></li></ul>
17
+ <h1>Interface ICursor</h1></div>
18
+ <section class="tsd-panel tsd-comment">
19
+ <div class="tsd-comment tsd-typography"><p>The cursor to the batch of data to be fetched.</p>
20
+ </div></section>
21
+ <section class="tsd-panel tsd-hierarchy">
22
+ <h4>Hierarchy</h4>
23
+ <ul class="tsd-hierarchy">
24
+ <li><span class="target">ICursor</span></li></ul></section>
25
+ <section class="tsd-panel">
26
+ <h4>Implemented by</h4>
27
+ <ul class="tsd-hierarchy">
28
+ <li><a href="../classes/Cursor.html" class="tsd-signature-type" data-tsd-kind="Class">Cursor</a></li></ul></section><aside class="tsd-sources">
29
+ <ul>
30
+ <li>Defined in <a href="https://github.com/Rishikant181/Rettiwt-API/blob/e11e4bf/src/types/Service.ts#L6">src/types/Service.ts:6</a></li></ul></aside>
31
+ <section class="tsd-panel-group tsd-index-group">
32
+ <section class="tsd-panel tsd-index-panel">
33
+ <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
34
+ <h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex=0><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M1.5 5.50969L8 11.6609L14.5 5.50969L12.5466 3.66086L8 7.96494L3.45341 3.66086L1.5 5.50969Z" fill="var(--color-text)"></path></svg> Index</h5></summary>
35
+ <div class="tsd-accordion-details">
36
+ <section class="tsd-index-section">
37
+ <h3 class="tsd-index-heading">Properties</h3>
38
+ <div class="tsd-index-list"><a href="ICursor.html#value" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)" id="icon-1024-text"></path></svg><span>value</span></a>
39
+ </div></section></div></details></section></section>
40
+ <section class="tsd-panel-group tsd-member-group">
41
+ <h2>Properties</h2>
42
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="value" class="tsd-anchor"></a>
43
+ <h3 class="tsd-anchor-link"><span>value</span><a href="#value" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" id="icon-anchor-c"></path></svg></a></h3>
44
+ <div class="tsd-signature">value<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
45
+ <div class="tsd-comment tsd-typography"><p>The cursor string.</p>
46
+ </div><aside class="tsd-sources">
47
+ <ul>
48
+ <li>Defined in <a href="https://github.com/Rishikant181/Rettiwt-API/blob/e11e4bf/src/types/Service.ts#L8">src/types/Service.ts:8</a></li></ul></aside></section></section></div>
49
+ <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
50
+ <div class="tsd-navigation settings">
51
+ <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
52
+ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Settings</h3></summary>
53
+ <div class="tsd-accordion-details">
54
+ <div class="tsd-filter-visibility">
55
+ <h4 class="uppercase">Member Visibility</h4><form>
56
+ <ul id="tsd-filter-options">
57
+ <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li>
58
+ <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li>
59
+ <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li>
60
+ <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div>
61
+ <div class="tsd-theme-toggle">
62
+ <h4 class="uppercase">Theme</h4><select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
63
+ <nav class="tsd-navigation primary">
64
+ <details class="tsd-index-accordion" open><summary class="tsd-accordion-summary">
65
+ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Modules</h3></summary>
66
+ <div class="tsd-accordion-details">
67
+ <ul>
68
+ <li><a href="../modules.html">rettiwt-<wbr/>api</a>
69
+ <ul></ul></li></ul></div></details></nav>
70
+ <nav class="tsd-navigation secondary menu-sticky">
71
+ <ul>
72
+ <li class="current tsd-kind-interface"><a href="ICursor.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-256-path"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)" id="icon-256-text"></path></svg><span>ICursor</span></a>
73
+ <ul>
74
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="ICursor.html#value" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>value</a></li></ul></li></ul></nav></div></div>
75
+ <div class="container tsd-generator">
76
+ <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
77
+ <div class="overlay"></div><script src="../assets/main.js"></script></body></html>