Class Server

Constructors

constructor

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

Properties

`Optional` `Readonly` host

host?: string

`Private` `Optional` hostname

hostname?: string

`Private` `Optional` ipAddress

ipAddress?: string

`Private` `Optional` localGroups

localGroups?: Required<Group>[]

`Private` `Optional` localUsers

localUsers?: Required<User>[]

Methods

downloadCommandOutput

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

execute

execute(command: Command, failIfNonZero?: boolean): neverthrow.ResultAsync<ExitedProcess, ProcessError>
Parameters
- command: Command
- failIfNonZero: boolean = true
Returns neverthrow.ResultAsync<ExitedProcess, ProcessError>
- Defined in houston-common-lib/lib/server.ts:141

getGroupByGid

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

getGroupByName

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

getGroupMembers

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

getHostname

getHostname(cache?: boolean): neverthrow.ResultAsync<string, ProcessError>
Parameters
- cache: boolean = true
Returns neverthrow.ResultAsync<string, ProcessError>
- Defined in houston-common-lib/lib/server.ts:112

getIpAddress

getIpAddress(cache?: boolean): neverthrow.ResultAsync<string, ParsingError | ProcessError>
Parameters
- cache: boolean = true
Returns neverthrow.ResultAsync<string, ParsingError | ProcessError>
- Defined in houston-common-lib/lib/server.ts:121

getLocalGroups

getLocalGroups(cache?: boolean): neverthrow.ResultAsync<Required<Group>[], ProcessError>
Parameters
- cache: boolean = true
Returns neverthrow.ResultAsync<Required<Group>[], ProcessError>
- Defined in houston-common-lib/lib/server.ts:208

getLocalUsers

getLocalUsers(cache?: boolean): neverthrow.ResultAsync<Required<User>[], ProcessError>
Parameters
- cache: boolean = true
Returns neverthrow.ResultAsync<Required<User>[], ProcessError>
- Defined in houston-common-lib/lib/server.ts:168

getServerInfo

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

getSystemImgPath

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

getUserByLogin

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

getUserByUid

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

getUserGroups

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

isAccessible

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

spawnProcess

spawnProcess(command: Command, defer?: boolean): Process
Parameters
- command: Command
- defer: boolean = false
Returns Process
- Defined in houston-common-lib/lib/server.ts:137

toString

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