Skip to content
On this page

Pre-release

You are looking at the website for the fully functional Feathers v5 (Dove) pre-release. Check out what's new, and please let us know about any issues or questions . The current v4 documentation can be found at crow.docs.feathersjs.com.

API

This section describes all the individual modules and APIs of Feathers.

Core

Feathers core functionality that works on the client and the server

  • Application - The main Feathers application API
  • Services - Service objects and their methods and Feathers specific functionality
  • Hooks - Pluggable middleware for service methods
  • Events - Events sent by Feathers service methods
  • Errors - A collection of error classes used throughout Feathers

Transports

Expose a Feathers application as an API server

  • Configuration - A node-config wrapper to initialize configuration of a server side application.
  • Koa - Feathers KoaJS framework bindings, REST API provider and error middleware.
  • Express - Feathers Express framework bindings, REST API provider and error middleware.
  • Socket.io - The Socket.io real-time transport provider
  • Channels - Channels are used to send real-time events to clients

Authentication

Feathers authentication mechanism

  • Service - The main authentication service configuration
  • Hook - The hook used to authenticate service method calls
  • Strategies - More about authentication strategies
  • Local - Local email/password authentication
  • JWT - JWT authentication
  • OAuth - Using OAuth logins (Facebook, Twitter etc.)

Client

More details on how to use Feathers on the client

  • Usage - Feathers client usage in Node, React Native and the browser (also with Webpack and Browserify)
  • REST - Feathers client and direct REST API server usage
  • Socket.io - Feathers client and direct Socket.io API server usage
  • Authentication - A client for Feathers authentication

Schema

Model definitions for validating and resolving data.

Databases

Feathers common database adapter API and querying mechanism

  • Adapters - A list of supported database adapters
  • Common API - Database adapter common initialization and configuration API
  • Querying - The common querying mechanism
  • MongoDB - The adapter for MongoDB databases
  • SQL - The adapter for SQL databases using KnexJS
  • Memory - The adapter for in-memory data storage

Released under the MIT License.