Giter VIP home page Giter VIP logo

aurelia-apollo's Introduction

aurelia-apollo-bind

Please change subscribe by watch and SubscriptionMode by WatchMode bigining with version 1.1.0.

This module help using Apollo queries by binding properties with decorators.

You can query or watch and use an other property for the parameters. Any time a parameter change, a new query is done.

Initialisation

You have to inject an instance of ApolloClient :

import { Container } from 'aurelia-dependency-injection';
import ApolloClient from 'apollo-client';
...
  const apolloClient = new ApolloClient(...);
  Container.instance.registerInstance(ApolloClient, apolloClient);
...

Use

import { ApolloBind } from 'aurelia-apollo-bind';
import gql from 'graphql-tag';

export class ContactList {
  @ApolloBind.query(gql`
query contactList {
  contactList {
    id
    ...
  }
}`)
  contacts;
}

By just changing query by watch, your query will be updated each time an update is done locally or from the server or from an other client.

Parameters

Each time you change the detailsId property, a new query is done.

import { ApolloBind } from 'aurelia-apollo-bind';
import gql from 'graphql-tag';

export class ContactDetails {
  @ApolloBind.query(gql`
query contactDetails($id: ID) {
  contactDetails(id: $id) {
    id
    ...
  }
}`, 'detailsId')
  details;
  detailsId;
}

Watch mode

import { ApolloBind, WatchMode } from 'aurelia-apollo-bind';
import gql from 'graphql-tag';

export class ContactList {
  @ApolloBind.watch(gql`
query contactList {
  contactList {
    id
    ...
  }
}`, WatchMode.local)
  contacts;
}

If you're pulling the server and don't use ws then the WatchMode can help you to force the sync of your app only locally for this query.

TODO

  • decorate the class to have general default class inits (pulling time, WatchMode)
  • Init the module to force defaults (by default, pulling timing is 500ms and WatchMode is remote)
  • Parameter can be an object
  • have a decorator like @ApolloBind.local to replace WatchMode.local
  • make update similar to the query way with save and revert functionalities.

Any suggestion is welcome !

Update proposition

This is not yet implemented but I need your reactions to make something easy to use and having all the needs.

We can bind functions with the module named contactSave(newData and oldData) and contactRevert(). The save() is called with no-parameter but newData and oldData are transmitted by the module.

export class contactDetails {
  @ApolloBind.query(..., detailsId)
  @ApolloBind.update(gql`
mutation saveContact($id: ID, ...) {
  saveContact(
    id: $id,
    ...
  ) {
    id
    ...
  }
}`)
  details;
  detailsId;

  somewhereElse() {
    if ... detailsSave() ... else ... detailsRevert() ...
  }

  detailsSave(datas?: Promise<{newData, oldData}>) {
    if(datas)
      datas.then((newData, oldData) => console.info('newData, oldData :', newData, oldData));
  }
  detailsRevert() {}
}

contactSave and contactRevert functions don't have to be there in javascript if we don't need the returned promise. In typescript, we need them cause of type cheking.

aurelia-apollo's People

Contributors

stphdenis avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.