import AtviseFile from 'atvise-scm/src/lib/AtviseFile.js'

public class | source

AtviseFile

Extends:

gulp-util~File → AtviseFile

Direct Subclass:

Node

A File subclass used for transform streams. Currently only extends vinyl by a rc property holding the runtime config.

Static Method Summary

Static Public Methods
public static	from(file: File, runtimeConfig: Object): AtviseFile Create an AtviseFile from a regular vinyl File.
public static	isCustomProp(name: String): Boolean A required method for the File subclass to work properly.

Constructor Summary

Public Constructor
public	constructor(options: Object) Creates a new AtviseFile based on some options.

Member Summary

Public Members
public get	nodeId: NodeId The file's node id.
public	rc: Object The file's runtime configuration

Method Summary

Public Methods
public	clone(options: Object): AtviseFile Returns a new AtviseFile with all attributes cloned.

Static Public Methods

public static from(file: File, runtimeConfig: Object): AtviseFile source

Create an AtviseFile from a regular vinyl File.

Params:

Name	Type	Attribute	Description
file	File		The source file
runtimeConfig	Object	optional default: {}	The runtime configuration to use.

Return:

AtviseFile

An AtviseFile based on file.

public static isCustomProp(name: String): Boolean source

A required method for the File subclass to work properly.

Params:

Name	Type	Attribute	Description
name	String		Property name

Return:

Boolean

Whether the property name is custom or not.

See:

https://github.com/gulpjs/vinyl#extending-vinyl

Public Constructors

public constructor(options: Object) source

Creates a new AtviseFile based on some options.

Params:

Name	Type	Attribute	Description
options	Object	optional	Options passed directly to File.
options.rc	Object	optional	The runtime configuration to attach to the file.

Public Members

public get nodeId: NodeId source

The file's node id.

public rc: Object source

The file's runtime configuration

Public Methods

public clone(options: Object): AtviseFile source

Returns a new AtviseFile with all attributes cloned.

Params:

Name	Type	Attribute	Description
options	Object	optional	The options passed to File#clone

Return:

AtviseFile

See:

https://github.com/gulpjs/vinyl#filecloneoptions