Class LicenseEvidenceGatherer<P>

Type Parameters

P extends string = string

Hierarchy (View Summary)

LicenseEvidenceGatherer
- Utils.LicenseUtility.LicenseEvidenceGatherer

Index

Constructors

Methods

getFileAttachments

Constructors

constructor

new LicenseEvidenceGatherer<P extends string = string>(
    options?: {
        fs?: Contrib.License.Utils.FsUtils<P>;
        path?: Contrib.License.Utils.PathUtils<P>;
    },
): Contrib.License.Utils.LicenseEvidenceGatherer<P>
fs and path can be supplied, if any compatibility-layer or drop-in replacement is used.
Type Parameters
- P extends string = string
Parameters
- options: {
  fs?: Contrib.License.Utils.FsUtils<P>;
  path?: Contrib.License.Utils.PathUtils<P>;
  } = {}
  - Optionalfs?: Contrib.License.Utils.FsUtils<P>
    If omitted, the native node:fs is used.
  - Optionalpath?: Contrib.License.Utils.PathUtils<P>
    If omitted, the native node:path is used.
Returns Contrib.License.Utils.LicenseEvidenceGatherer<P>
- Defined in src/contrib/license/utils.node.ts:64

Methods

getFileAttachments

getFileAttachments(
prefixPath: P,
onError?: Contrib.License.Utils.ErrorReporter,
): Generator<Contrib.License.Utils.FileAttachment<P>>
Parameters
- prefixPath: P
- onError: Contrib.License.Utils.ErrorReporter = noop
Returns Generator<Contrib.License.Utils.FileAttachment<P>>
- Defined in src/contrib/license/utils.node.ts:72