0.1.1 • Published 3 years ago

@tsei/note v0.1.1

Weekly downloads
-
License
MIT
Repository
github
Last release
3 years ago

Install via npm

  • npm i -S @tsei/note

Get Started

  • git clone https://github.com/tseijp/note
  • cd note, npm i and npm start
  • open browser and visit http://localhost:3000
  • Now you can go to our demo, and try its usage.

Recipes

Note

manage note data and api
const [note, set] = useNote(url, fetcher, config)

<Note url="..."
  fetcher={...}
  {...config}>
  {(note, set) =>
    <>{/*_*/}</>
  }
</Note>
  1. @url: string
  2. @fetcher: function
  3. @config: object
  1. @note: Note
  2. @set: function
User

manage user info and API
const [user, set] = useUser(url, fetcher, config)

<User url="..."
  fetcher={...}
  {...config}>
  {(user, set) =>
    <>{/*_*/}</>
  }
</User>
  1. @url: string
  2. @fetcher: function
  3. @config : object
  1. @user: User

    • @username : user name from fetched API e.g. tseijp
    • @authtoken: user token from cookie
    • @input : for input Components
    • @status : the acton at fetch e.g. IN, UP, OUT or ""
    • @userlang : user language from window.navigator.language e.g. ja, en
  2. @set:

      <details>
    
      - `setUser()`       : Toggle fetching
      - ~`setUser(null)`   : switch status IN->UP or UP->IN~
      - ~`setUser(boolean)`: switch status '' or IN|UP|OUT~
    
      </details>

Available API

URLDescription
/auth/Distribute Auth Token
/api/Restful Api Router
/api/note/Note Api
key of /api/noteDescription
nextnext pagination url
previousprevious pagination url
resultsseriaized data as array
results0.idprimary key
results0.note_idprimary key of parent
results0.ja_texttext data
results0.en_texttext data
results0.is_authorwhether request user is author
results0.posted_timetime when it was posted
results0.author_nameusername of posted user