@ta-interaktiv/newsnet-api-flow-types
Advanced tools
Flow type definitions for stuff the Newsnet API returns.
Flow typing for the stuff the Newsnet API produces.
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 stringid stringname stringdescription string?url stringpicture string?twitter string?rss stringThe available types of communities so far.
Caching Information. Not exactly sure what that does, but it is part of a lot of configuration objects.
Type: {cache: ("true" | "false"), refresh: string}
Properties
cache ("true" | "false")refresh stringDate string, of the form "dd.MM.YYYY HH:mm:SS".
Type: string
Community object, used for providing social media information.
Type: {type: CommunityType, count: number, article_id: string, share_type_id: string, url: string?, description: string?, name: string?, title: string?, description: string?, facebook_id: string?, via: string?, allow_comments_weekdays: boolean?, allow_comments_weekends: boolean?, comment_count_text: string?}
Properties
type CommunityTypecount numberarticle_id stringshare_type_id stringurl string?description string?name string?title string?description string?facebook_id string?via string?allow_comments_weekdays boolean?allow_comments_weekends boolean?comment_count_text string?Community list, as provided by /api/articles/<legacy_id>/communities
Type: {communities: Array<Community>}
Properties
communities Array<Community>I guess this should be a boolean, but it is returned as a string
Date Object, in the form 'DD.MM.YYYY hh:mm:ss'
External services combines several meta data about an article.
Provided by /api/articles/<legacy_id>/external_services
Type: {configs: any, paywall: Paywall, ads: Ads, statistics: Array<Statistic>, communities: Array<Community>}
Properties
Basic Paywall object
Part of /api/articles/<legacy_id> and
/api/articles/<legacy_id>/external_services
Type: any
Status of the paywall:
Type: (0 | 1 | 2)
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 stringAdditional properties for Statistic objects of type 'wemf'. Use with flow type intersections.
Type: {url: string, webapp_url: string, iphone_url: string, ipad_url: string, android_url: string, desktop_url: string}
Properties
Examples
let wemfInfo: Statistic & Wemf
Additional properties for Statistic object of type 'webseismo'. Use with flow type intersections.
Type: {url_desktop: string, url_webapp: string, url_smartphone: string, url_tablet: string, url: string}
Properties
Examples
let webseismoInfo: Statistic & Webseismo
Additional properties for Statistic objects of type 'gtm'. Use with flow type intersections.
Type: {article_id: number, article_title: string, article_type: string, pagetype: string, premium: boolean, publish_date: number, category: string, subcategory: string}
Properties
article_id numberarticle_title stringarticle_type stringpagetype stringpremium booleanpublish_date numbercategory stringsubcategory stringExamples
let gtmInfo: Statistic & Gtm
The article type, as provided by the Newsnet API.
Provided by /api/articles/<legacy_id>
Type: {article: ArticleContent}
Properties
article ArticleContentThe contents of an article. The API wraps these contents below an
article key.
Type: {id: string, legacy_id: number, title: string, title_short: string, picture_small_url: string, picture_medium_url: string, picture_big_url: string, lead: string, lead_short: string, lead_teaser: string, timestamp_updated_at: number, first_published_at: number, external_services: {statistics: Array<Statistic>, ads: any, paywall: Paywall}, authors: Array<Author>}
Properties
id stringlegacy_id numbertitle stringtitle_short stringpicture_small_url stringpicture_medium_url stringpicture_big_url stringlead stringlead_short stringlead_teaser stringtimestamp_updated_at numberfirst_published_at numberexternal_services {statistics: Array<Statistic>, ads: any, paywall: Paywall}external_services.statistics Array<Statistic>external_services.ads anyexternal_services.paywall Paywallauthors Array<Author>Site configuration that is also part of the External_Services object
Type: {name_short: string, name: string, title: string, language: string, feedback_url: string, ads_enabled: boolean, facebook_id: string, facebook_url: string, twitter_via: string, gtm_id: string, paywall_status: PaywallStatus}
Properties
name_short stringname stringtitle stringlanguage stringfeedback_url stringads_enabled booleanfacebook_id stringfacebook_url stringtwitter_via stringgtm_id stringpaywall_status PaywallStatus'TA' or 'B'
Full name of publication
Name with tag line
Common information about the site.
Type: any
General information about the site.
Provided by /api/sites/default
Type: {site: any}
Properties
site any
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
FAQs
Flow type definitions for stuff the Newsnet API returns.
The npm package @ta-interaktiv/newsnet-api-flow-types receives a total of 0 weekly downloads. As such, @ta-interaktiv/newsnet-api-flow-types popularity was classified as not popular.
We found that @ta-interaktiv/newsnet-api-flow-types demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.