@quesk/types
TypeScript icon, indicating that this package has built-in type declarations

0.3.1 • Public • Published

@quesk/types

With this package, you are installing the types needed for the correct typing of the Quesk models (from GraphQL).

Installation & Usage

Since this is a public package, you can install the package in your project using yarn or npm. Use one of the following two command to install the package:

$ yarn add @quesk/types
$ npm install --save @quesk/types

When you want to use the package, it's important to know, that there is no default export in this package. We are only exporting the variables/constants/types/interfaces that are shown below this paragraph.

To use the package, please use the following import lines:

import { Category } from '@quesk/types'

type Root = Category & { isAnotherType: boolean }

Introspection

You can see the introspection of the queries we are supporting on http://emily.quesk.io/graphiql.

Types

Category

Representing a Category object from GraphQL.

Name Type
name string
questionCount number
followedByUser boolean

User

Representing a User object from GraphQL.

Name Type
firstName string
lastName string
name string
location string
tagLine string
website string
biography string
avatarUrl string
isCurrentUser boolean
isVerified boolean
isFollowedByCurrentUser boolean
interestedIn Array of type Category
savedQuestions Array of type Question
askedQuestions Array of type Question
answers Array of type Answer
receivedUpvotesCount number
followerCount number
answersCount number

Answer

Representing a Answer object from GraphQL.

Name Type
body string
author Single entity of type User`
createdAt ISO Date String
updatedAt ISO Date String
voteCount number
userIsAuthor boolean
upvotedByCurrentUser boolean
downvotedByCurrentUser boolean
question? Single entity of type Question

Question

Representing a Question object from GraphQL.

Name Type
title string
body string
impressionCount number
category Single entity of type Category
categoryId string
hasTopAnswer boolean
isAnonymous boolean
topAnswer Single entity of type Answer
answers Array of type Answer
author Single entity of type User
userHasSaved boolean
userIsAuthor boolean
createdAt ISO Date String
updatedAt ISO Date String

Package Sidebar

Install

npm i @quesk/types

Homepage

quesk.io

Weekly Downloads

0

Version

0.3.1

License

MIT

Unpacked Size

5.2 kB

Total Files

4

Last publish

Collaborators

  • visualcookie
  • iduuck