Class SambaManagerConfFile
Hierarchy-Diagram
Legend
class
abstract class
protected property
private property
public method
private method
italic
abstract property/method
Hierarchy (view full)
- SambaManagerBase
- SambaManagerConfFile
Implements
Index
Constructors
Properties
Methods
add
Constructors
constructor
- new
Samba Manager Conf File(confFile: File): SambaManagerConfFile Parameters
- confFile: File
Returns SambaManagerConfFile
Properties
Private command
Protected conf
Methods
add
- add
Share(share: SambaShareConfig): neverthrow.ResultAsync<SambaShareConfig, ProcessError> Parameters
- share: SambaShareConfig
share configuration to add
Returns neverthrow.ResultAsync<SambaShareConfig, ProcessError>
- share: SambaShareConfig
edit
- edit
Global(globalConfig: SambaGlobalConfig): neverthrow.ResultAsync<SambaGlobalConfig, ParsingError | ProcessError> Update current global configuration
Parameters
- globalConfig: SambaGlobalConfig
New global configuration
Returns neverthrow.ResultAsync<SambaGlobalConfig, ParsingError | ProcessError>
- globalConfig: SambaGlobalConfig
edit
- edit
Share(share: SambaShareConfig): neverthrow.ResultAsync<SambaShareConfig, ProcessError> Update an existing share configuration NOTE: cannot simply update share name. see ()
Parameters
- share: SambaShareConfig
new share configuration
Returns neverthrow.ResultAsync<SambaShareConfig, ProcessError>
- share: SambaShareConfig
export
- export
Config(): neverthrow.ResultAsync<string, ProcessError> Dump configuration to smb.conf format as string
Returns neverthrow.ResultAsync<string, ProcessError>
get
- get
Global Config(): neverthrow.ResultAsync<SambaGlobalConfig, ParsingError | ProcessError> Get current global configuration
Returns neverthrow.ResultAsync<SambaGlobalConfig, ParsingError | ProcessError>
get
- get
Share(shareName: string): neverthrow.ResultAsync<SambaShareConfig, ParsingError | ProcessError> Get share configuration by name
Parameters
- shareName: string
Returns neverthrow.ResultAsync<SambaShareConfig, ParsingError | ProcessError>
get
- get
Shares(): neverthrow.ResultAsync<SambaShareConfig[], ParsingError | ProcessError> Get all share configurations
Returns neverthrow.ResultAsync<SambaShareConfig[], ParsingError | ProcessError>
import
- import
Config(config: string): neverthrow.ResultAsync<SambaManagerConfFile, ProcessError> Import configuration from smb.conf format string
Parameters
- config: string
smb.conf format string
Returns neverthrow.ResultAsync<SambaManagerConfFile, ProcessError>
- config: string
list
- list
Share Names(): neverthrow.ResultAsync<string[], ProcessError> Get list of all share names
Returns neverthrow.ResultAsync<string[], ProcessError>
Private modify
- modify
Config File<TErr extends Error>(callback: ((config: SambaConfig) => neverthrow.Result<SambaConfig, TErr>)): neverthrow.ResultAsync<void, ParsingError | ProcessError | TErr> Type Parameters
- TErr extends Error
Parameters
- callback: ((config: SambaConfig) => neverthrow.Result<SambaConfig, TErr>)
- (config: SambaConfig): neverthrow.Result<SambaConfig, TErr>
Parameters
- config: SambaConfig
Returns neverthrow.Result<SambaConfig, TErr>
Returns neverthrow.ResultAsync<void, ParsingError | ProcessError | TErr>
Private modify
- modify
Config File Text<TErr extends Error>(callback: ((config: string) => neverthrow.Result<string, TErr>)): neverthrow.ResultAsync<void, ProcessError | TErr> Type Parameters
- TErr extends Error
Parameters
- callback: ((config: string) => neverthrow.Result<string, TErr>)
- (config: string): neverthrow.Result<string, TErr>
Parameters
- config: string
Returns neverthrow.Result<string, TErr>
Returns neverthrow.ResultAsync<void, ProcessError | TErr>
parse
- parse
Config(config: string): neverthrow.Result<SambaConfig, ParsingError> Parse complete samba configuration text (e.g. contents of smb.conf) into configuration object
Parameters
- config: string
Complete configuration text
Returns neverthrow.Result<SambaConfig, ParsingError>
- config: string
parse
- parse
Global Config(globalConfig: string): neverthrow.Result<SambaGlobalConfig, ParsingError> Parse global configuration text into global config object
Parameters
- globalConfig: string
Global configuration text, including '[global]' header
Returns neverthrow.Result<SambaGlobalConfig, ParsingError>
- globalConfig: string
parse
- parse
Share Config(shareConfig: string): neverthrow.Result<SambaShareConfig, ParsingError> Parse configuration text into a share object
Parameters
- shareConfig: string
Share configuration text, including '[share name]' header
Returns neverthrow.Result<SambaShareConfig, ParsingError>
- shareConfig: string
recommended
- recommended
Global Defaults(): neverthrow.Result<SambaGlobalConfig, ParsingError> Recommended defaults for global configuration. Maintained in ./recommended-defaults.conf
Returns neverthrow.Result<SambaGlobalConfig, ParsingError>
recommended
- recommended
Share Defaults(): neverthrow.Result<SambaShareConfig, ParsingError> Recommended defaults for a new share. Maintained in ./recommended-defaults.conf
Returns neverthrow.Result<SambaShareConfig, ParsingError>
Private reload
- reload
Config(): neverthrow.ResultAsync<void, ProcessError> Returns neverthrow.ResultAsync<void, ProcessError>
remove
- remove
Share(share: SambaShareConfig): neverthrow.ResultAsync<SambaShareConfig, ProcessError> Remove an existing share configuration
Parameters
- share: SambaShareConfig
share to remove
Returns neverthrow.ResultAsync<SambaShareConfig, ProcessError>
- share: SambaShareConfig
rename
- rename
Share(oldName: string, newName: string): neverthrow.ResultAsync<SambaShareConfig, ParsingError | ProcessError> Rename a share
Parameters
- oldName: string
- newName: string
Returns neverthrow.ResultAsync<SambaShareConfig, ParsingError | ProcessError>
set
- set
User Password(user: string, passwd: string): neverthrow.ResultAsync<void, ProcessError> Add samba user with specific passwd
Parameters
- user: string
- passwd: string
Returns neverthrow.ResultAsync<void, ProcessError>
unparse
- unparse
Config(config: SambaConfig): neverthrow.Result<string, ParsingError> Unparse comlete samba configuration object back into smbd.conf format text
Parameters
- config: SambaConfig
Returns neverthrow.Result<string, ParsingError>
Add a new share configuration