diff --git a/README.md b/README.md index 181202f..0a44423 100644 --- a/README.md +++ b/README.md @@ -29,12 +29,12 @@ yarn add @arifszn/blog-js ## Usage -- **getDevtoPost()**: Get 10 recent posts from [dev.to](https://dev.to) +- **getDevPost()**: Get 10 recent posts from [dev](https://dev.to) ```js - const { getDevtoPost } = require('@arifszn/blog-js'); + const { getDevPost } = require('@arifszn/blog-js'); - getDevtoPost({ + getDevPost({ user: 'yourusername', }).then((res) => { console.log(res); diff --git a/index.d.ts b/index.d.ts index dab472f..c21f736 100644 --- a/index.d.ts +++ b/index.d.ts @@ -15,8 +15,8 @@ interface options { declare function getMediumPost(options: options): Promise; /** - * Get most recent dev.to posts + * Get most recent dev posts */ -declare function getDevtoPost(options: options): Promise; +declare function getDevPost(options: options): Promise; -export { getMediumPost, getDevtoPost }; +export { getMediumPost, getDevPost }; diff --git a/index.js b/index.js index 06da40d..f78e10d 100644 --- a/index.js +++ b/index.js @@ -1,42 +1,42 @@ -const { request, formatMediumPost, formatDevtoPost } = require("./util"); +const { request, formatMediumPost, formatDevPost } = require('./util'); module.exports = { - /** - * Get most recent medium posts - * - * @param {Object} param - * @returns {Array} posts - */ - getMediumPost: async ({ - user - }) => { - try { - if (!user) return []; + /** + * Get most recent medium posts + * + * @param {Object} param + * @returns {Array} posts + */ + getMediumPost: async ({ user }) => { + try { + if (!user) return []; - let response = await request(`https://api.rss2json.com/v1/api.json?rss_url=https://medium.com/feed/@${user}`); + let response = await request( + `https://api.rss2json.com/v1/api.json?rss_url=https://medium.com/feed/@${user}` + ); - return response.data.items.map(item => formatMediumPost(item)); - } catch (error) { - return []; - } - }, - /** - * Get most recent dev.to posts - * - * @param {Object} param - * @returns {Array} posts - */ - getDevtoPost: async ({ - user - }) => { - try { - if (!user) return []; - - let response = await request(`https://dev.to/api/articles?per_page=10&username=${user}`); + return response.data.items.map((item) => formatMediumPost(item)); + } catch (error) { + return []; + } + }, + /** + * Get most recent dev posts + * + * @param {Object} param + * @returns {Array} posts + */ + getDevPost: async ({ user }) => { + try { + if (!user) return []; + + let response = await request( + `https://dev.to/api/articles?per_page=10&username=${user}` + ); - return response.data.map(item => formatDevtoPost(item)); - } catch (error) { - return []; - } + return response.data.map((item) => formatDevPost(item)); + } catch (error) { + return []; } -} \ No newline at end of file + }, +}; diff --git a/util.js b/util.js index 2da31fb..d61046a 100644 --- a/util.js +++ b/util.js @@ -39,12 +39,12 @@ const formatMediumPost = (post) => { }; /** - * Format raw dev.to post + * Format raw dev post * * @param {Object} post * @return {Object} formatted post */ -const formatDevtoPost = (post) => { +const formatDevPost = (post) => { return { title: post.title.trim(), description: post.description.replace('\n', '').trim(), @@ -73,4 +73,4 @@ const textEllipsis = (str, length = 100, ending = '...') => { module.exports.request = request; module.exports.formatMediumPost = formatMediumPost; -module.exports.formatDevtoPost = formatDevtoPost; +module.exports.formatDevPost = formatDevPost;