Class JavascriptParser

Dockta Parser class for Node.js.

Hierarchy

Parser
- JavascriptParser

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new JavascriptParser(urlFetcher: UrlFetcher, folder: string | undefined): JavascriptParser

Inherited from Doer.constructor
- Defined in src/Doer.ts:22
Parameters
- urlFetcher: UrlFetcher
- folder: string | undefined
Returns JavascriptParser

Properties

folder

folder: string

The directory to scan for relevant files

Protected Readonly urlFetcher

urlFetcher: UrlFetcher

The instance of IUrlFetcher to fetch URLs

Methods

Private createPackage

createPackage(data: any): Promise<SoftwarePackage>

- Defined in src/JavascriptParser.ts:60
Create a SoftwarePackage instance from a Node.js package meta-data object

Meta-data for a packages dependencies is obtained from https://registry.npmjs.org/ using the JSON API documented at https://github.com/npm/registry/blob/master/docs/responses/package-metadata.md and https://github.com/npm/registry/blob/master/docs/REGISTRY-API.md. Currently we fetch the abbreviated metadata because the full meta data can be very large.

The column "NodeJS" in https://github.com/codemeta/codemeta/blob/master/crosswalk.csv is used to translate package meta-data into a SoftwarePackage instance.

Parameters
- data: any
  
  Package object
Returns Promise<SoftwarePackage>

exists

exists(subpath: string): boolean

Inherited from Doer.exists
- Defined in src/Doer.ts:35
Does a path exist within the project folder?

Parameters
- subpath: string
  
  The path within the folder
Returns boolean

fetch

fetch(url: string, options?: any): Promise<any>

Inherited from Doer.fetch
- Defined in src/Doer.ts:83
Fetch content from a URL

Parameters
- url: string
  
  The URL to fetch
- Default value options: any = { responseType: 'json' }
  
  Request options
Returns Promise<any>

glob

glob(pattern: string | Array<string>): Array<string>

Inherited from Doer.glob
- Defined in src/Doer.ts:44
Get a list of paths that match a pattern in the project folder.

Parameters
- pattern: string | Array<string>
  
  The glob pattern
Returns Array<string>

parse

parse(): Promise<SoftwarePackage | null>

Overrides Parser.parse
- Defined in src/JavascriptParser.ts:19
Parse a folder to detect any package.json or *.js source code files and return a SoftwarePackage instance

Returns Promise<SoftwarePackage | null>

read

read(subpath: string): string

Inherited from Doer.read
- Defined in src/Doer.ts:63
Read a file within the project folder

Parameters
- subpath: string
  
  The path within the folder
Returns string

write

write(subpath: string, content: string): void

Inherited from Doer.write
- Defined in src/Doer.ts:73
Write to a file within the project folder

Parameters
- subpath: string
  
  The path within the folder
- content: string
  
  The content to write to the file
Returns void

Generated using TypeDoc