--- layout: default title: "Platform API" categories: - api ---

API Documentation

On GitHub

{{ page.title }}

NoFlo - Flow-Based Programming for JavaScript
(c) 2014-2017 Flowhub UG
NoFlo may be freely distributed under the MIT license
{% raw %} 
/* eslint-disable
    no-console,
    no-undef,
*/
{% endraw %}

Platform detection method

{% raw %} 
/**
 * @returns {boolean}
 */
export function isBrowser() {
  if ((typeof process !== 'undefined') && process.execPath && process.execPath.match(/node|iojs/)) {
    return false;
  }
  return true;
}
{% endraw %}

Mechanism for showing API deprecation warnings. By default logs the warnings but can also be configured to throw instead with the NOFLO_FATAL_DEPRECATED env var.

{% raw %} 
/**
 * @param {string} message
 * @returns {void}
 */
export function deprecated(message) {
  if (isBrowser()) {
    console.warn(message);
    return;
  }
  if (process.env.NOFLO_FATAL_DEPRECATED) {
    throw new Error(message);
  }
  console.warn(message);
}

/**
 * @param {Function} func
 * @returns {void}
 */
export function makeAsync(func) {
  if (isBrowser()) {
    setTimeout(func, 0);
    return;
  }
  setImmediate(() => {
    func();
  });
}
{% endraw %}

This page contains documentation generated automatically from NoFlo's Platform.js file.