Skip to content

Commit 1326b99

Browse files
Sobhan-SRZAxo-aria
Sobhan-SRZA
and
xo-aria
committed
change version
Co-Authored-By: XO Aria <104579901+xo-aria@users.noreply.github.com>
1 parent 596bb8b commit 1326b99

File tree

2 files changed

+10
-10
lines changed

2 files changed

+10
-10
lines changed

‎README.md‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -132,15 +132,15 @@ const {
132132

133133
## API Reference
134134

135-
| Function | Description | Parameters | Returns | |
136-
| ---------------------------------------------- | -------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------- | --- |
137-
| `topAuthors(limit?)` | Fetches authors sorted by total views | `limit` (number, default `10`): number of authors to return (1–50) | `Author[]` | |
138-
| `authorPosts(tag, limit?, sort?)` | Retrieves published posts by a given author | `tag` (string): display name and profile ID (e.g., "jane-doe-123")<br>`limit` (number, default `10`)<br>`sort` ("newest", "most\_viewed", default "newest") | `Post[]` | |
139-
| `getTags(limit?)` | Returns tags with their associated post counts | `limit` (number, default `20`): number of tags (1–100) | `Tag[]` | |
140-
| `explore(search?, page?, limit?, sort?, tag?)` | Paginated list of articles with filtering and sorting | `search` (string)<br>`page` (number, default `1`)<br>`limit` (number, default `12`)<br>`sort` ("recommended", "newest", "most\_viewed", default "newest")<br>`tag` (string) | `Post[]` | |
141-
| `websiteInformation()` | Site statistics including last post, total views, posts, and authors | — | `SiteInformation` | |
142-
| `lastPosts(limit?)` | Fetches the most recent published posts | `limit` (number, default `10`) | `Post[]` | |
143-
| `qrCode(url)` | Generates a QR code image buffer for the specified URL | `url` (string): URL to encode | `Buffer` | |
135+
| Function | Description | Parameters | Returns |
136+
| ---------------------------------------------- | -------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------- |
137+
| `topAuthors(limit?)` | Fetches authors sorted by total views | `limit` (number, default `10`): number of authors to return (1–50) | `Author[]` |
138+
| `authorPosts(tag, limit?, sort?)` | Retrieves published posts by a given author | `tag` (string): display name and profile ID (e.g., "jane-doe-123")<br>`limit` (number, default `10`)<br>`sort` ("newest", "most\_viewed", default "newest") | `Post[]` |
139+
| `getTags(limit?)` | Returns tags with their associated post counts | `limit` (number, default `20`): number of tags (1–100) | `Tag[]` |
140+
| `explore(search?, page?, limit?, sort?, tag?)` | Paginated list of articles with filtering and sorting | `search` (string)<br>`page` (number, default `1`)<br>`limit` (number, default `12`)<br>`sort` ("recommended", "newest", "most\_viewed", default "newest")<br>`tag` (string) | `Post[]` |
141+
| `websiteInformation()` | Site statistics including last post, total views, posts, and authors | `---` | `SiteInformation` |
142+
| `lastPosts(limit?)` | Fetches the most recent published posts | `limit` (number, default `10`) | `Post[]` |
143+
| `qrCode(url)` | Generates a QR code image buffer for the specified URL | `url` (string): URL to encode | `Buffer` |
144144

145145
---
146146

‎package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@persian-caesar/hycom-api",
3-
"version": "1.1.3",
3+
"version": "1.1.5",
44
"description": "A package for easy using hycom.ir api service.",
55
"main": "dist/index.js",
66
"types": "dist/index.d.ts",

0 commit comments

Comments
 (0)