functional-request-handler v0.1.1

functional-request-handler

functional-request-handler

Index

Modules

• "GetEntitiesHandler"
• "GetEntityHandler"
• "ListEntitiesHandler"
• "Request"
• "index"

functional-request-handler

functional-request-handler

Modules

functional-request-handler › "GetEntitiesHandler"

Module: "GetEntitiesHandler"

Index

Interfaces

• GetEntitiesCallables

functional-request-handler › "GetEntityHandler"

Module: "GetEntityHandler"

Index

Interfaces

• GetEntityCallables

functional-request-handler › "index"

Module: "index"

Index

References

• Callables
• Request
• RequestHandler
• Storage
• isGetRequest
• isPostRequest
• makeGetEntitiesHandler
• makeGetEntityHandler
• makeListEntitiesHandler

References

Callables

• Callables:

Request

• Request:

RequestHandler

• RequestHandler:

Storage

• Storage:

isGetRequest

• isGetRequest:

isPostRequest

• isPostRequest:

makeGetEntitiesHandler

• makeGetEntitiesHandler:

makeGetEntityHandler

• makeGetEntityHandler:

makeListEntitiesHandler

• makeListEntitiesHandler:

functional-request-handler › "ListEntitiesHandler"

Module: "ListEntitiesHandler"

Index

Interfaces

• ListEntitiesCallables

functional-request-handler › "Request"

Module: "Request"

Index

Interfaces

• Callables
• Request
• Storage

Type aliases

• RequestHandler

Variables

• isGetRequest
• isPostRequest

Type aliases

RequestHandler

Ƭ RequestHandler: function

Defined in Request.ts:32

Type declaration:

▸ (request: Request): Task‹Response‹Entity››

Parameters:

Variables

Const isGetRequest

• isGetRequest: function = propSatisfies( equals('GET'), 'method' )

Defined in Request.ts:12

Type declaration:

▸ (request: Request): boolean

Parameters:

Const isPostRequest

• isPostRequest: function = propSatisfies( equals('POST'), 'method' )

Defined in Request.ts:17

Type declaration:

▸ (request: Request): boolean

Parameters:

Interfaces

functional-request-handler › "GetEntitiesHandler" › GetEntitiesCallables

Interface: GetEntitiesCallables <Entity, Reference>

Type parameters

▪ Entity: Model

▪ Reference

Hierarchy

• Callables‹Entity›

  ↳ GetEntitiesCallables

Index

Properties

• fromModel
• getModelFromReference
• getReferencesFromRequest
• predicate

Properties

fromModel

• fromModel: function

Inherited from Callables.fromModel

Defined in Request.ts:29

Type declaration:

▸ (model: Model): E.Either‹Error, Entity›

Parameters:

getModelFromReference

• getModelFromReference: ReaderTaskEither‹Reference, Error, Model›

Defined in GetEntitiesHandler.ts:13

getReferencesFromRequest

• getReferencesFromRequest: function

Defined in GetEntitiesHandler.ts:14

Type declaration:

▸ (request: Request): Reference[]

Parameters:

predicate

• predicate: function

Inherited from Callables.predicate

Defined in Request.ts:28

Type declaration:

▸ (request: Request): boolean

Parameters:

functional-request-handler › "GetEntityHandler" › GetEntityCallables

Interface: GetEntityCallables <Entity, Reference>

Type parameters

▪ Entity: Model

▪ Reference

Hierarchy

• Callables‹Entity›

  ↳ GetEntityCallables

Index

Properties

• fromModel
• getModelFromReference
• getReferenceFromRequest
• predicate

Properties

fromModel

• fromModel: function

Inherited from Callables.fromModel

Defined in Request.ts:29

Type declaration:

▸ (model: Model): E.Either‹Error, Entity›

Parameters:

getModelFromReference

• getModelFromReference: ReaderTaskEither‹Reference, Error, Model›

Defined in GetEntityHandler.ts:12

getReferenceFromRequest

• getReferenceFromRequest: function

Defined in GetEntityHandler.ts:13

Type declaration:

▸ (request: Request): Reference

Parameters:

predicate

• predicate: function

Inherited from Callables.predicate

Defined in Request.ts:28

Type declaration:

▸ (request: Request): boolean

Parameters:

functional-request-handler › "ListEntitiesHandler" › ListEntitiesCallables

Interface: ListEntitiesCallables <Entity, Response>

Type parameters

▪ Entity: Model

▪ Response

Hierarchy

• Callables‹Entity›

  ↳ ListEntitiesCallables

Index

Properties

• fromModel
• getModels
• getResponseFromEntity
• predicate

Properties

fromModel

• fromModel: function

Inherited from Callables.fromModel

Defined in Request.ts:29

Type declaration:

▸ (model: Model): E.Either‹Error, Entity›

Parameters:

getModels

• getModels: TaskEither‹Error, Model[]›

Defined in ListEntitiesHandler.ts:13

getResponseFromEntity

• getResponseFromEntity: function

Defined in ListEntitiesHandler.ts:14

Type declaration:

▸ (entity: Entity): Response

Parameters:

predicate

• predicate: function

Inherited from Callables.predicate

Defined in Request.ts:28

Type declaration:

▸ (request: Request): boolean

Parameters:

functional-request-handler › "Request" › Callables

Interface: Callables <Entity>

Type parameters

▪ Entity: Model

Hierarchy

• Callables

  ↳ GetEntitiesCallables

  ↳ GetEntityCallables

  ↳ ListEntitiesCallables

Index

Properties

• fromModel
• predicate

Properties

fromModel

• fromModel: function

Defined in Request.ts:29

Type declaration:

▸ (model: Model): E.Either‹Error, Entity›

Parameters:

predicate

• predicate: function

Defined in Request.ts:28

Type declaration:

▸ (request: Request): boolean

Parameters:

functional-request-handler › "Request" › Request

Interface: Request

Hierarchy

• Request

Index

Properties

• method

Properties

method

• method: "GET" | "POST" | string

Defined in Request.ts:9

functional-request-handler › "Request" › Storage

Interface: Storage

Hierarchy

• Storage

Index

Properties

• firestore
• table

Properties

firestore

• firestore: Firestore

Defined in Request.ts:23

table

• table: string

Defined in Request.ts:24