1.0.2 • Published 5 years ago

detect-file-content v1.0.2

Weekly downloads
3
License
ISC
Repository
github
Last release
5 years ago

Introduction

detect-file-content will detect file content string intervally.

Params

namedescriptiontypedefaultrequired
internalTimeinterval durationNumber: Millisecond1000false
maxTimesinterval durationNumber: Int180false
filePathabsolute file pathString''true
matchRegRegExpmatchRegnull''true

Returns

  • success

    { success: true, count: 10, content: 'xxx' }

    count: detect count content: file content

  • fail

    { success: false, reason: 'xxx', count: xx }

    count: detect count

    reasons

    • params error

      • "filePath" should be passed in as string
      • "matchReg" should be passed in as RegExp
    • timeout: 'timeout'

Usage

const detectResult = await detect({ 
    filePath: 'xxx/xx/xxx.json', 
    matchReg: /hello/, 
    maxTimes: 12, 
    internalTime: 500 
});
console.log(detectResult);

log:

{ success: true, count: 10, content: 'xxx }
{ success: false, count: 10, reason: 'timeout' }