Foundry376/Mailspring
1
1
Fork 0
mirror of https://github.com/Foundry376/Mailspring.git synced 2024-09-21 15:56:10 +08:00
Code Issues Packages Projects Releases Wiki Activity
Mailspring/packages/isomorphic-core
History
Halla Moore 097a96274f [isomorphic-core] Make sure specs can run without electron 
Summary:
Isomorphic-core should be functional outside of the client environment

Depends on D4056

Test Plan: Run the test suite

Reviewers: evan, spang, juan

Reviewed By: spang, juan

Differential Revision: https://phab.nylas.com/D4062
2017-03-01 11:10:41 -08:00
..
spec [isomorphic-core] Make sure specs can run without electron 2017-03-01 11:10:41 -08:00
src [iso-core] Fix typo in IMAPBox 2017-02-28 11:16:37 -08:00
index.js [*] Move Jasmine setup into isomorphic-core 2017-03-01 11:08:37 -08:00
package.json [isomorphic-core] Make sure specs can run without electron 2017-03-01 11:10:41 -08:00
README.md [*] update and add READMEs to each package 2017-02-17 17:28:09 -08:00

README.md

Isomorphic Core

Isomorphic refers to javascript that can be run on both the client and the server.

This is shared code for mail and utilities that is designed to run both on deployed cloud servers and from within the Nylas Mail client.

Use through a regular import: import iso-core from 'isomorphic-core'

It is required as a dependency in the package.json of other modules.

This library isn't on the npm registry, but works as a dependency thanks to lerna bootstrap

See index.js for what gets explicitly exported by this library.

Important Usage Notes:

Since this code runs in both the client and the server, you must be careful with what libraries you use. Some common gotchas:

  • You can't use NylasEnv or NylasExports. These are injected only in the client.
  • If you require a 3rd party library, it must be added to the "dependencies" of isomorphic-core's package.json
  • You may use modern javascript syntax. Both the client and server get compiled with the same .babelrc setting