@ta-interaktiv/newsnet-api-flow-types - npm Package Compare versions

Comparing version 0.1.1 to 0.2.0

CHANGELOG.md

@@ -0,1 +1,11 @@
+<a name="0.2.0"></a>
+# [0.2.0](https://gitlab.com/ta-interaktiv/newsnet-api-flow-types/compare/0.1.1...0.2.0) (2017-08-10)
+
+
+### Fix
+
+* Update definition to wrap the contents of an article below an `article` key ([aa2d069eaf7adb6c04c88a2e2dbc30892a337dd9](https://gitlab.com/ta-interaktiv/newsnet-api-flow-types/commit/aa2d069eaf7adb6c04c88a2e2dbc30892a337dd9))
+
+
+
 <a name="0.1.1"></a>
@@ -2,0 +12,0 @@ ## [0.1.1](https://gitlab.com/ta-interaktiv/newsnet-api-flow-types/compare/0.1.0...0.1.1) (2017-08-09)

index.js

 // @flow
 
-export type { Article } from './src/article'
+export type { Article, ArticleContent } from './src/article'
 export type { Author } from './src/author'
 export type { Statistic } from './src/statistic'

package.json

 {
   "name": "@ta-interaktiv/newsnet-api-flow-types",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "description": "Flow type definitions for stuff the Newsnet API returns.",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -17,2 +17,15 @@ # Newsnet API Flow Types
 
+Type: {article: [ArticleContent](#articlecontent)}
+
+**Properties**
+
+-   `article` **[ArticleContent](#articlecontent)** 
+
+### ArticleContent
+
+-   **See: [Article](#article)**
+
+The contents of an article. The API wraps these contents below an
+`article` key.
+
 Type: {id: [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String), legacy_id: [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number), title: [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String), title_short: [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String), picture_small_url: [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String), picture_medium_url: [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String), picture_big_url: [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String), lead: [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String), lead_short: [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String), lead_teaser: [string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String), timestamp_updated_at: [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number), first_published_at: [number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number), external_services: {statistics: [Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<[Statistic](#statistic)>, ads: any, paywall: any}, authors: [Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)<[Author](#author)>}
@@ -19,0 +32,0 @@

src/article.js

@@ -9,6 +9,14 @@ // @flow
  * Provided by `/api/articles/<legacy_id>`
- *
+ */
+export type Article = {
+  article: ArticleContent
+}
+/**
+ * The contents of an article. The API wraps these contents below an
+ * `article` key.
+ * 
+ * @see {@link Article}
  * @todo Add all properties (right now not all of them are present)
  */
-export type Article = {
+export type ArticleContent = {
   id: string,
@@ -32,2 +40,2 @@ legacy_id: number,
   authors: Array<Author>
-}
+}

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

12215

increased by7.19%

Lines of code

70

increased by14.75%

Number of lines in readme file

108

increased by13.68%

No dependency changes