feathers-loopback-connector

Installation

npm install feathers-loopback-connector --save

Documentation

Please refer to the feathers-loopback-connector documentation for more details.

Complete Example

Here's an example of a Feathers server that uses feathers-loopback-connector.

import { feathers } from '@feathersjs/feathers'
import express, { json, urlencoded, rest } from '@feathersjs/express'
import { LoopBackService } from 'feathers-loopback-connector';
import { DataSource } from 'loopback-datasource-juggler';
const ds = new DataSource('memory');
// mongodb or postgresql
// const ds = new DataSource({
//     connector: 'loopback-connector-mongodb',
//     connector: 'loopback-connector-postgresql',
//     url: ""
// });

interface Message {
    id: number
    text: string
}

type ServiceTypes = {
    messages: LoopBackService<Message>;
}

const app = express(feathers<ServiceTypes>());

app.use(json())
app.use(urlencoded({ extended: true }))
app.configure(rest());

var MessageSchema = ds.createModel('messages', {
    id: { type: Number },
    text: { type: String }
});

app.use('messages', new LoopBackService({
    id: "_id",
    multi: true,
    model: MessageSchema,
    paginate: {
        default: 10,
        max: 100
    }
}));

app
    .listen(3000, () => {
        console.log('Feathers server listening on localhost:3000')
    });

Supported Loopback specific queries

On top of the standard, cross-adapter queries, feathers-loopback-connector also supports Loopback specific queries.

$and

query: {
  $and: [{ field1: 'foo' }, { field2: 'bar' }]
}

$between

query: {
  size: { $between: [0,7] }
}

$inq

query: {
  id: { $inq: [123, 234] }
}

$like

query: {
  name: { $like: '%St%' }
}

$nlike

query: {
  name: { $nlike: 'M%XY' }
}

$ilike

query: {
  title: { $ilike: 'm.-st' }
}

$nilike

query: {
  title: { $nilike: 'm.-xy' }
}

$regexp

query: {
  title: { $regexp: '^T' }
}

$near

location = '42.266271,-72.6700016';  // String
location = [42.266271, -72.6700016]; // Array
location = { lat: 42.266271, lng: -72.6700016 };  // Object Literal
query: {
  geo: { $near: location }
}

$maxDistance

query: {
    geo: {
        $near: location,
        $maxDistance: 2
    }
}

$minDistance

query: {
    geo: {
        $near: location,
        $minDistance: 2
    }
}

$unit

To change the units of measurement, specify unit property to one of the following:

kilometers
meters
miles
feet
radians
degrees

query: {
    geo: {
        $near: location,
        $maxDistance: 2,
        $unit: 'kilometers'
    }
}

License

Licensed under the MIT license.

kethan / feathers-loopback-connector Goto Github PK

feathers-loopback-connector's Introduction