stc-helper

Helper for stc

Usage no npm install needed!

<script type="module">
  import stcHelper from 'https://cdn.skypack.dev/stc-helper';
</script>

README

stc-helper

NPM version Build Status Coverage Status Dependency Status

helper for stc.

Install

npm install stc-helper

How to use

import {isFile} from 'stc-helper';
if(isFile('xxx')){
  
}

API

isStream(stream)

check is stream.

import {isStream} from 'stc-helper';
if(isStream(stream){
  
}

isBuffer(buffer)

check is buffer.

import {isBuffer} from 'stc-helper';
if(isBuffer(buf){
  
}

isArray(arr)

check is array.

isFunction(fn)

check is function.

isObject(obj)

isString(str)

isRegExp(regexp)

check is RegExp.

isExist(filePath)

check file/dir is exist.

isFile(filepath)

isDirectory(dir)

extend(target, source)

deep copy

let obj = extend({}, {name: 'stc'})

getFiles(dir, prefix = '')

get files from dir.

import {getFiles} from 'stc-helper';

let files = getFiles('/path/to'); // return is array

promisify(fn, receiver)

make callback function to promise.

import {promisify} from 'stc-helper';
import fs from 'fs'

let fn = promisify(fs.readFile, fs);
fn('/path/to/file', 'utf8').then(content => {
  
})

defer()

get Deferred object.

import {defer} from 'stc-helper';

let fn => {
  let deferred = defer();
  if(xxx){
    deferred.resolve('xxx');
  }else{
    deferred.reject(new Error());
  }
  return deferred.promise;
}

md5(str)

get content md5 value.

asyncReplace(content, replace, callback)

async content replace

import {asyncReplace} from 'stc-helper';

let fn = async content => {
  return asyncReplace(content, /\d+/, (a, b) => {
    return Promise.resolve(a);
  });
}

isRemoteUrl(url)

check is remote url

isRemoteUrl('http://www.stcjs.org/'); //true
isRemoteUrl('https://www.stcjs.org/'); //true
isRemoteUrl('//www.stcjs.org/'); //true

chmod(dir)

mkdir(dir)