medium-story
TypeScript icon, indicating that this package has built-in type declarations

0.1.5 • Public • Published

medium-story

medium-story is a package used to fetch medium stories.

Features

  • Fetch stories from medium.com, by rss feed.
  • Works in both browser and node environment.
  • Typescript support.

Usage

Node

import getMediumStories from 'medium-story'
 
async someFunc () {
    const stories = await getMediumStories('Your-Medium-Username')
 
    for (const story of stories.items) {
        console.log(story.title)
        // title: string;
        // link: string;
        // pubDate: Date;
        // content: string;
        // creator: string;
        // guid: string;
        // categories: string[];
        // isoDate: Date;
    }
}

Browser

import getMediumStories from 'medium-story'
 
async someFunc () {
    const stories = await getMediumStories('Your-Medium-Username', { cors: true })
 
    for (const story of stories.items) {
        console.log(story.title)
        // title: string;
        // link: string;
        // pubDate: Date;
        // content: string;
        // creator: string;
        // guid: string;
        // categories: string[];
        // isoDate: Date;
    }
}

Types

export interface Story {
    title: string;
    link: string;
    pubDate: Date;
    content: string;
    creator: string;
    guid: string;
    categories: string[];
    isoDate: Date;
}
export interface StoriesResult {
    items: Story[];
    feedUrl: string;
    image: {
        link: string;
        url: string;
        title: string;
    };
    title: string;
    description: string;
    webMaster: string;
    generator: string;
    link: string;
    lastBuildDate: Date;
}
declare type corsFunc = (url: string) => string;
export interface getStoriesOptions {
    cors?: boolean | corsFunc;
    timeout?: number;
}
export default function getStories(username: string, options?: getStoriesOptions): Promise<StoriesResult>;
export {};

Explain

medium-story use medium feeds to get latest stories from specified account.

Thanks to cors.io, you can use it in browser, too!

Due to medium's limit, you can only get recent 10 stories.

Readme

Keywords

Package Sidebar

Install

npm i medium-story

Weekly Downloads

0

Version

0.1.5

License

MIT

Unpacked Size

17.7 kB

Total Files

7

Last publish

Collaborators

  • banyudu