STRFY
Display the object in the browser for easy viewing
use it
var strfy = var sample = str: 'hello world!!' num: 999 arr: 1 2 3 4 5 6 7 bool: true fn: { return false; } obj: a: 1 b: 'box' c: 'x' 'y' 'z' un: void 0 nil: null ; strfy // or strfy
大きなObjectをconsole.log
等で表示しても、全体像の把握が困難です。
その解決手段としてstrfyを作りました。
strfy.open
は引数のobjectをbrowserで開きます。
内部的にはhtmlに変換し、TMPDIR(osごとに異なるtemporary directory)に保存します。それをosごとに異なるopenコマンドで開きます。
strfy.open(object)
で動作しますが、これはpromiseオブジェクトを返します。
なので一部のtest環境など動作しない場合は適切にthen
,catch
を配置する必要があります。
また、promiseなのでawait
も使用できます。
strfy.open
は実行するたびに新しいwindowを開きます。
この挙動が不満なら、strfy.save
が使えば保存のみを行います。
install
npm i strfy --save-dev # or yarn add strfy --dev
api
open
引数に渡したobjectをBrowserで表示します。
returnしたPromiseはhtmlファイルのpathを返します。
Arguments
Object (Object | Array)
Returns
Promise Object
Example
strfy;
save
strfy.open
は自動でBrowserを開きますが、この関数は保存だけを行います。
Promiseはhtmlファイルのpathを返します。
Arguments
Object (Object | Array)
Returns
Promise Object
Example
strfy;
path
htmlのpathを取得します。
Arguments
none
Returns
path (string)
Example
strfy
with browsersync
browsersyncを使うと別のPCやスマートフォン等に表示することもできます。
> URI={{html_path}} &&browser-sync start --server $URI --files $URI/strfy.html --startPath "/strfy.html"