adds typings

Author: bdbch

package.json

@@ -3,6 +3,7 @@
   "version": "1.0.4",
   "description": "Dev.to hooks for Github API",
   "main": "src/index.js",
+  "types": "types.d.ts",
   "repository": "https://github.com/bdbch/react-devto",
   "author": "@d2k",
   "license": "MIT",
@@ -18,7 +19,8 @@
     "src/*.js",
     "src/*.json",
     "src/**/*.js",
-    "src/**/*.json"
+    "src/**/*.json",
+    "types.d.ts"
   ],
   "scripts": {},
   "devDependencies": {

types.d.ts

@@ -0,0 +1,82 @@
+declare module "@d2k/react-devto" {
+  export interface IBaseUser {
+    name: string;
+    username: string;
+    twitter_username?: string;
+    github_username?: string;
+    website_url?: string;
+    profile_image?: string;
+    profile_image_90?: string;
+  }
+
+  export interface IUser extends IBaseUser {
+    type_of: "user";
+    summary?: string;
+    location?: string;
+    joined_at?: string;
+    following?: boolean;
+  }
+
+  export interface ITag {
+    id?: number;
+    name: string;
+    bg_color_hex: string;
+    text_color_hex: string;
+  }
+
+  export interface IPost {
+    type_of: "article";
+    id: number;
+    title: string;
+    description?: string;
+    cover_image?: string;
+    published_at: string;
+    tag_list?: string[];
+    slug: string;
+    path: string;
+    url: string;
+    canonical_url: string;
+    comments_count: number;
+    positive_reactions_count: number;
+    published_timestamp: string;
+    user: IBaseUser;
+    flare_tag?: ITag;
+  }
+
+  export interface IResponse {
+    loading: boolean;
+    error?: string;
+  }
+
+  export interface IArticlesResponse extends IResponse {
+    articles?: IPost[];
+  }
+
+  export interface IUserResponse extends IResponse {
+    user?: IUser;
+  }
+
+  export interface IFollowSuggestionsResponse extends IResponse {
+    suggestions?: IUser[];
+  }
+
+  export interface ITagsResponse extends IResponse {
+    tags?: ITag[];
+  }
+
+  /** Fetches Dev.to articles and returns an array of 20 items */
+  function useArticles(
+    page?: number,
+    tag?: string,
+    username?: string
+  ): IArticlesResponse;
+
+  /** Fetches a user from Dev.to by either a username or id */
+  function useUser(username?: string, id?: string): IUserResponse;
+
+  /** Fetches follow suggestions */
+  function useFollowSuggestions(): IFollowSuggestionsResponse;
+
+  /** Fetches tags */
+  function useTags(page?: number): ITagsResponse;
+}