Class Server

Constructors

constructor

new Server(host?: string): Server
Parameters
- Optional host: string
Returns Server
- Defined in houston-common-lib/dist/lib/server.d.ts:37

Properties

`Optional` `Readonly` host

host?: string

`Private` `Optional` hostname

hostname?: any

`Private` `Optional` ipAddress

ipAddress?: any

`Private` `Optional` localGroups

localGroups?: any

`Private` `Optional` localUsers

localUsers?: any

Methods

downloadCommandOutput

downloadCommandOutput(command: Command, filename: string): void
Parameters
- command: Command
- filename: string
Returns void
- Defined in houston-common-lib/dist/lib/server.d.ts:45

execute

execute(command: Command, failIfNonZero?: boolean): ResultAsync<ExitedProcess, ProcessError>
Parameters
- command: Command
- Optional failIfNonZero: boolean
Returns ResultAsync<ExitedProcess, ProcessError>
- Defined in houston-common-lib/dist/lib/server.d.ts:44

getGroupByGid

getGroupByGid(gid: number): ResultAsync<Group, ProcessError>
Parameters
- gid: number
Returns ResultAsync<Group, ProcessError>
- Defined in houston-common-lib/dist/lib/server.d.ts:53

getGroupByName

getGroupByName(groupName: string): ResultAsync<Required<Group>, ProcessError | ValueError>
Parameters
- groupName: string
Returns ResultAsync<Required<Group>, ProcessError | ValueError>
- Defined in houston-common-lib/dist/lib/server.d.ts:52

getGroupMembers

getGroupMembers(group: Group): ResultAsync<Required<User>[], ProcessError | ValueError>
Parameters
- group: Group
Returns ResultAsync<Required<User>[], ProcessError | ValueError>
- Defined in houston-common-lib/dist/lib/server.d.ts:49

getHostname

getHostname(cache?: boolean): ResultAsync<string, ProcessError>
Parameters
- Optional cache: boolean
Returns ResultAsync<string, ProcessError>
- Defined in houston-common-lib/dist/lib/server.d.ts:41

getIpAddress

getIpAddress(cache?: boolean): ResultAsync<string, ProcessError | ParsingError>
Parameters
- Optional cache: boolean
Returns ResultAsync<string, ProcessError | ParsingError>
- Defined in houston-common-lib/dist/lib/server.d.ts:42

getLocalGroups

getLocalGroups(cache?: boolean): ResultAsync<Required<Group>[], ProcessError>
Parameters
- Optional cache: boolean
Returns ResultAsync<Required<Group>[], ProcessError>
- Defined in houston-common-lib/dist/lib/server.d.ts:47

getLocalUsers

getLocalUsers(cache?: boolean): ResultAsync<Required<User>[], ProcessError>
Parameters
- Optional cache: boolean
Returns ResultAsync<Required<User>[], ProcessError>
- Defined in houston-common-lib/dist/lib/server.d.ts:46

getServerInfo

getServerInfo(): ResultAsync<Partial<ServerInfo>, ProcessError | SyntaxError>
Returns ResultAsync<Partial<ServerInfo>, ProcessError | SyntaxError>
- Defined in houston-common-lib/dist/lib/server.d.ts:39

getSystemImgPath

getSystemImgPath(): Promise<string>
Returns Promise<string>
- Defined in houston-common-lib/dist/lib/server.d.ts:40

getUserByLogin

getUserByLogin(login: string): ResultAsync<Required<User>, ProcessError | ValueError>
Parameters
- login: string
Returns ResultAsync<Required<User>, ProcessError | ValueError>
- Defined in houston-common-lib/dist/lib/server.d.ts:50

getUserByUid

getUserByUid(uid: number): ResultAsync<User, ProcessError>
Parameters
- uid: number
Returns ResultAsync<User, ProcessError>
- Defined in houston-common-lib/dist/lib/server.d.ts:51

getUserGroups

getUserGroups(user: User): ResultAsync<Required<Group>[], ProcessError | ValueError>
Parameters
- user: User
Returns ResultAsync<Required<Group>[], ProcessError | ValueError>
- Defined in houston-common-lib/dist/lib/server.d.ts:48

isAccessible

isAccessible(): ResultAsync<true, ProcessError>
Returns ResultAsync<true, ProcessError>
- Defined in houston-common-lib/dist/lib/server.d.ts:38

spawnProcess

spawnProcess(command: Command, defer?: boolean): Process
Parameters
- command: Command
- Optional defer: boolean
Returns Process
- Defined in houston-common-lib/dist/lib/server.d.ts:43

toString

toString(): string
Returns string
- Defined in houston-common-lib/dist/lib/server.d.ts:54