func-has-param v1.1.1

func-has-param

Check if function in file has parameter

Install

npm install --save func-has-param

Usage

ES2015 (ES6)

import fs from 'fs';
import funcHasParam from 'func-has-param';

let coffeeFile, jsFile, tsFile;

// contents of awesome-js-file.js
/**
 * function test(param) {}
 */
jsFile = fs.readFileSync('awesome-js-file.js');

funcHasParam(jsFile, 'test', 'param');
// => true

funcHasParam(jsFile, 'test', 'x');
// => false


// contents of awesome-coffee-file.coffee
/**
 * test = (param) -> {}
 */
coffeeFile = fs.readFileSync('awesome-coffee-file.coffee');

funcHasParam(coffeeFile, 'test', 'param', {language: 'coffee'});
// => true

funcHasParam(coffeeFile, 'test', 'x', {language: 'coffee'});
// => false


// contents of awesome-ts-file.ts
/**
 * function test (param: string): string {}
 */
tsFile = fs.readFileSync('awesome-ts-file.ts');

funcHasParam(tsFile, 'test', 'param', {language: 'ts'});
// => true

funcHasParam(tsFile, 'test', 'param', {language: 'ts', type: 'string'});
// => true

funcHasParam(tsFile, 'test', 'param', {language: 'ts', type: 'int'});
// => false

funcHasParam(tsFile, 'test', 'x', {language: 'ts'});
// => false

ES5

var fs = require('fs')
  , funcHasParam = require('func-has-param')
  , coffeeFile, jsFile, tsFile;

// contents of awesome-js-file.js
/**
 * function test(param) {}
 */
jsFile = fs.readFileSync('awesome-js-file.js');

funcHasParam(jsFile, 'test', 'param');
// => true

funcHasParam(jsFile, 'test', 'x');
// => false

// contents of awesome-coffee-file.coffee
/**
 * test = (param) -> {}
 */
coffeeFile = fs.readFileSync('awesome-coffee-file.coffee');

funcHasParam(coffeeFile, 'test', 'param', {language: 'coffee'});
// => true

funcHasParam(coffeeFile, 'test', 'x', {language: 'coffee'});
// => false


// contents of awesome-ts-file.ts
/**
 * function test (param: string): string {}
 */
tsFile = fs.readFileSync('awesome-ts-file.ts');

funcHasParam(tsFile, 'test', 'param', {language: 'ts'});
// => true

funcHasParam(tsFile, 'test', 'param', {language: 'ts', type: 'string'});
// => true

funcHasParam(tsFile, 'test', 'param', {language: 'ts', type: 'int'});
// => false

funcHasParam(tsFile, 'test', 'x', {language: 'ts'});
// => false

Options

language

A string with the language of the file being inspected. Default option is js for JavaScript. Other possible options are coffee for CoffeeScript and ts for TypeScript.

regex

Custom regex to use. Must include a group.

type

Only used when using language option with ts value. A string that's used to match the parameter type as well as the parameter name.

LICENSE

MIT