@ta-interaktiv/newsnet-api-flow-types

Newsnet API Flow Types

Flow typing for the stuff the Newsnet API produces.

API

Article

The article type, as provided by the Newsnet API.

Provided by /api/articles/<legacy_id>

Type: {id: string, legacy_id: number, title: string, title_short: string, picture_small_url: string, picture_medium_url: string, timestamp_updated_at: number, first_published_at: number, external_services: {statistics: Array<Statistic>, ads: any, paywall: any}, authors: Array<Author>}

Properties

• id string
• legacy_id number
• title string
• title_short string
• picture_small_url string
• picture_medium_url string
• timestamp_updated_at number
• first_published_at number
• external_services {statistics: Array<Statistic>, ads: any, paywall: any}
• external_services.statistics Array<Statistic>
• external_services.ads any
• external_services.paywall any
• authors Array<Author>

Author

• See: Article

Author object, being part of /api/articles/<legacy_id>

Type: {type: string, id: string, name: string, description: string?, url: string, picture: string?, twitter: string?, rss: string}

Properties

• type string
• id string
• name string
• description string?
• url string
• picture string?
• twitter string?
• rss string

Statistic

• See: Article

Basic statistic object.

Part of /api/articles/<legacy_id> and /api/articles/<legacy_id>/external_services.

Type: {provider: ("wemf" | "webseismo" | "gtm"), type: string}

Properties

• provider ("wemf" | "webseismo" | "gtm")
• type string

Contributing

Development

Building & Releasing

Changes should go into the changelog. The format is based on Keep a Changelog and this project adheres to Semantic Versioning. Update the changelog using the last commit messages since the last version tag using

yarn run changelog

Update the Readme with the current API using

yarn run docs