Skip to content

Telestion Documentation

Headers

wuespace/telestion

Telestion Documentation

wuespace/telestion

Overview
Overview
- Concepts
  Concepts
  - Services
  - Message Bus
- Project folder structure
Backend Development
Backend Development
- TypeScript
  TypeScript
- Using other languages
- Service Behavior Specification
  Service Behavior Specification
Frontend Development
Frontend Development
- Concepts
- API Reference
  API Reference
  - Application
    
    Application
    
    Functions
    Functions
    
    initTelestion
  - Auth
    
    Auth
    
    Classes
    Classes
    
    LoginError
    
    Functions
    Functions
    
    attemptAutoLogin
    
    getNatsConnection
    
    getUser
    
    isLoggedIn
    
    Login
    
    Logout
    
    setAutoLoginCredentials
    
    setNatsConnection
    
    setUser
    
    useNatsSubscription
    
    Interfaces
    Interfaces
    
    ErrorMessages
    
    User
  - Index
    
    Index
    
    Functions
    Functions
    
    JSONCodec
    
    registerWidgets
    
    useNats
    
    useWidgetConfig
    
    Interfaces
    Interfaces
    
    TelestionOptions
    
    Widget
    
    Type aliases
    Type aliases
    
    UserData
  - Nats
    
    Nats
    
    Classes
    Classes
    
    NatsError
    
    Functions
    Functions
    
    StringCodec
    
    Headers Headers
    Table of contents
    
    Parameters
    
    Returns
    
    Interfaces
    Interfaces
    
    Codec
    
    Msg
    
    MsgHdrs
    
    NatsConnection
    
    PublishOptions
    
    RequestOptions
    
    Sub
    
    SubOpts
    
    Type aliases
    Type aliases
    
    MsgRequest
    
    Subscription
    
    SubscriptionOptions
  - User data
    
    User data
    
    Functions
    Functions
    
    getBlankUserData
    
    getEmptyDashboard
    
    getUserData
    
    removeUserData
    
    setUserData
    
    Type aliases
    Type aliases
    
    Dashboard
    
    WidgetInstance
    
    Variables
    Variables
    
    dashboardSchema
    
    idSchema
    
    jsonSchema
    
    layoutSchema
    
    semverRegExp
    
    userDataSchema
    
    widgetInstanceSchema
  - Utils
    
    Utils
    
    Functions
    Functions
    
    generateDashboardId
    
    isUserDataUpToDate
    
    loadFileContents
    
    Wait
  - Widget
    
    Widget
    
    Functions
    Functions
    
    WidgetConfigCheckboxField
    
    WidgetConfigTextField
    
    WidgetConfigWrapper
    
    WidgetRenderer
    
    getWidgetById
    
    getWidgets
    
    useConfigureWidget
    
    useConfigureWidgetField
    
    Interfaces
    Interfaces
    
    WidgetRendererProps
    
    Type aliases
    Type aliases
    
    BaseWidgetConfiguration
    
    Variables
    Variables
    
    widgetConfigContext
Deployment
Deployment
- Concepts
- Local Deployment
  Local Deployment
  - Deploying NATS
  - Deploying TypeScript services
- Docker Deployment
  Docker Deployment
- Kubernetes Deployment
  Kubernetes Deployment
- NATS Configuration
  NATS Configuration
Project Homepage ↗️

Headers

@wuespace/telestion / nats / headers

headers(code?, description?): MsgHdrs

Parameters¶

• code?: number

• description?: string

Returns¶