Socket
Socket
Sign inDemoInstall

fp-ts-http

Package Overview
Dependencies
Maintainers
1
Versions
4
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

fp-ts-http

Opinionated Typesafe http middleware library using fp-ts-routing and io-ts


Version published
Weekly downloads
5
Maintainers
1
Weekly downloads
 
Created
Source

fp-ts-http

Install

Includes fp-ts fp-ts-routing and io-ts

npm i fp-ts-http

Example

import { end, lit, int } from 'fp-ts-routing'
import * as io from "io-ts"
import { get, post, driver } from "fp-ts-http"
import { TMiddlewareStack } from 'fp-ts-http/lib/Middleware';
import { none } from 'fp-ts/lib/Option';

const stack: TMiddlewareStack = []

const userById = lit('users').then(int("userid"))

const stack2 = [...stack, ...get<{userid: number}, string>(userById.then(end), async(req) => {
  return {
    status: 200,
    headers: none,
    body: `fetched user ${req.path.userid}`
  }
})]

const userMessages = userById.then(lit("messages"))
const userMessageDto = io.type({ message: io.string })

const stack3 = [...stack2, ...post<{userid: number}, {message: string}, string>(userMessages.then(end), userMessageDto, async(req) => {
  return {
    status: 200,
    headers: none,
    body: `post message "${req.body.message}" to user ${req.path.userid}`
  }
})]


driver(stack3, 3000).run()
  .then(() => console.log("server running"))

Advanced query parsing example


import { end, lit, query, str } from 'fp-ts-routing'
import * as io from "io-ts"
import { get, post, driver } from "."
import { TMiddlewareStack } from './Middleware';
import { none } from 'fp-ts/lib/Option';
import { NumberFromString, BooleanFromString, ArrayFromString } from './Query';


const stack: TMiddlewareStack = []

type TUsersPath = {
  type: string;
}

const usersQuery = io.strict({
  filter: io.union([ io.undefined, io.string ]),
  validStatusCodes: io.union([ io.undefined, ArrayFromString<number>(NumberFromString) ]),
  sortBy: io.union([ io.undefined, io.string]),
  sortDirection: io.union([ io.undefined, BooleanFromString])
})

type TUsersQuery = io.TypeOf<typeof usersQuery>

type TUsersResponseBody = string

const users = lit("users").then(str("type"))

const stack2 = [...stack, ...get<TUsersPath, TUsersQuery, TUsersResponseBody>(users.then(end), usersQuery, async(req) => {
  return {
    status: 200,
    headers: none,
    body: await UserRepository.find({ 
      type: req.path.type, 
      sortBy: req.path.sortBy,
      sortDirection: req.path.sortDirection
    })
  }
})]

type TUserMessageDto = {
  message: string
}

const userMessages = users.then(lit("messages"))
const userMessageDto = io.type({ message: io.string })

type TUserMessagesResponseBody = string

const stack3 = [...stack2, ...post<TUsersPath, TUsersQuery, TUserMessageDto, TUserMessagesResponseBody>(userMessages.then(end), usersQuery, userMessageDto, async(req) => {

  const users = await UserRepository.find({ 
    type: req.path.type, 
    sortBy: req.path.sortBy,
    sortDirection: req.path.sortDirection
  })

  await Promise.all(users.map(async user => sendMessageToUser(user, req.body)))

  return {
    status: 200,
    headers: none,
    body: JSON.stringify(req.path)
  }
})]


driver(stack3, 3000).run()
  .then(() => console.log("server running"))

Keywords

FAQs

Package last updated on 29 Jun 2019

Did you know?

Socket

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.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc