meteor-electrify-client

2.0.0 • Public • Published

Electrify Meteor Client

npm dependencies

This is the client for communication with the Electron part of an electrified Meteor app, that was created using the meteor-electrify package.

Integrating the client

At a startup script (for client and/or server) in your meteor application run the following code.

import { Meteor } from 'meteor/meteor';
import { Random } from 'meteor/random';
import { ElectrifyClient } from 'meteor-electrify-client';
 
export const Electrify = new ElectrifyClient(Meteor, Random);
 
// now you can use the Electrify api methods

The ElectrifyClient constructor can consume an optional options object as 3rd argument with:

  • connectionWarning (boolean)

    Show a warning if the meteor application is run without electrify/Electron. Defaults to true.

Using the client

Then, in your Meteor code (client and server), you can call this method like:

import { Electrify } from './file/where/electrify/is/exported.js';
 
// Electrify.call(method_name, args, done_callback);
Electrify.call('hello.world', ['anderson', 'arboleya'], function(err, msg) {
  console.log(msg); // Hello anderson arboleya!
});

IMPORTANT

You can only call methods after the connection is made between Meteor and Electron, to make sure it's ready you can wrap your code in a startup block:

Electrify.startup(function(){
  Electrify.call(...);
});

If you want to run your Meteor application electrified and as server version, you can check if it is running inside electron.

if (Electrify.connected) {
  Electrify.call(...);
}

License

The MIT License (MIT)

Copyright (c) 2017-2019 Sebastian Große Electrify originally created by Copyright (c) 2015 Anderson Arboleya

Package Sidebar

Install

npm i meteor-electrify-client

Weekly Downloads

14

Version

2.0.0

License

MIT

Unpacked Size

12.7 kB

Total Files

5

Last publish

Collaborators

  • mairu-master