FileService class
Defines an file service connection.
- Extends
Constructors
| File |
Creates a new FileService instance. |
Properties
| path | File path. |
Inherited Properties
| id | Unique Id for the service. |
| name | Friendly name for the service. |
| type |
Methods
| decrypt(string, (value: string, secret: string) => string) | Decrypt properties on this service. |
| encrypt(string, (value: string, secret: string) => string) | Encrypt properties on this service. |
Inherited Methods
| toJSON() | Creates a JSON based version of the model for saving to disk. |
Constructor Details
FileService(IFileService)
Creates a new FileService instance.
new FileService(source?: IFileService)Parameters
- source
- IFileService
(Optional) JSON based service definition.
Property Details
path
File path.
path: stringProperty Value
string
Inherited Property Details
id
name
Friendly name for the service.
name: stringProperty Value
string
Inherited From ConnectedService.name
type
Method Details
decrypt(string, (value: string, secret: string) => string)
Decrypt properties on this service.
function decrypt(_secret: string, _decryptString: (value: string, secret: string) => string)Parameters
- _secret
-
string
Secret to use to decrypt.
- _decryptString
-
(value: string, secret: string) => string
Function called to decrypt an individual value.
encrypt(string, (value: string, secret: string) => string)
Encrypt properties on this service.
function encrypt(_secret: string, _encryptString: (value: string, secret: string) => string)Parameters
- _secret
-
string
Secret to use to encrypt.
- _encryptString
-
(value: string, secret: string) => string
Function called to encrypt an individual value.
Inherited Method Details
toJSON()
Creates a JSON based version of the model for saving to disk.
function toJSON(): IConnectedServiceReturns
An IConnectedService JSON.
Inherited From ConnectedService.toJSON