LogoLogo
ChangelogGitHubTwitterGitter
v2.x
v2.x
  • Introduction
  • Overview
    • Getting started
    • Effects
    • Routing
    • Middlewares
    • Error handling
    • How does it glue​ together?
  • Advanced
    • Context
    • Server events
    • Validation
    • Streaming
    • Output interceptor
  • WebSockets
    • Getting started
    • Effects
    • Middlewares
    • Error handling
    • Connections handling
  • API Reference
    • core
      • bindTo
      • createServer
      • combineRoutes
      • createContextToken
      • EffectFactory
      • r.pipe
      • httpListener
      • operator: matchEvent
      • operator: use
    • websockets
      • webSocketListener
      • operator: broadcast
      • operator: mapToServer
    • middleware-body
    • middleware-logger
    • middleware-io
    • middleware-jwt
      • Token signing
    • middleware-joi
    • middleware-cors
    • middleware-multipart
  • Other
    • Migration from version 1.x
    • Changelog
    • FAQ
Powered by GitBook
On this page
  • Importing
  • Type declaration
  • Parameters
  • Returns
  • Example
  1. API Reference
  2. core

createServer

Marble.j abstraction over Node.js server creation with additional features.

Importing

import { createServer } from '@marblejs/core';

Type declaration

createServer ::  CreateServerConfig -> Server

Parameters

parameter

definition

config

CreateServerConfig

CreateServerConfig

parameter

definition

httpListener

HttpListener

port

<optional> number

hostname

<optional> string

event$

<optional> HttpServerEffect

options

<optional> ServerOptions

dependencies

<optional> Array<BoundDependency<any>>

Returns

parameter

definitoin

run

boolean? -> https.Server | http.Server

info

ServerInfo

server

https.Server | http.Server

ServerInfo

parameter

definitoin

routing

Array<RoutingItem>

Example

index.ts
import httpListener from './http.listener';
import { createServer, bindTo } from '@marblejs/core';

const httpsOptions: https.ServerOptions = {
  key: fs.readFileSync('key.pem'),
  cert: fs.readFileSync('cert.pem'),
};

export const server = createServer({
  port: 1337,
  hostname: '127.0.0.1',
  httpListener,
  dependencies: [
    bindTo(fooToken)(foo),
  ],
  event$: (...args) => merge(
    listening$(...args),
    upgrade$(...args),
  ),
  options: { httpsOptions },
});

server.run(
  process.env.NODE_ENV !== 'test'
);
PreviousbindToNextcombineRoutes

Last updated 6 years ago