mirror of
https://github.com/Start9Labs/start-os.git
synced 2026-03-26 18:31:52 +00:00
34 lines
922 B
TypeScript
34 lines
922 B
TypeScript
import { ServiceInterfaceType } from "../StartSdk"
|
|
import { Effects } from "../types"
|
|
import { Scheme } from "./Host"
|
|
|
|
/**
|
|
* A helper class for creating a Network Interface
|
|
*
|
|
* Network Interfaces are collections of web addresses that expose the same API or other resource,
|
|
* display to the user with under a common name and description.
|
|
*
|
|
* All URIs on an interface inherit the same ui: bool, basic auth credentials, path, and search (query) params
|
|
*
|
|
* @param options
|
|
* @returns
|
|
*/
|
|
export class ServiceInterfaceBuilder {
|
|
constructor(
|
|
readonly options: {
|
|
effects: Effects
|
|
name: string
|
|
id: string
|
|
description: string
|
|
hasPrimary: boolean
|
|
disabled: boolean
|
|
type: ServiceInterfaceType
|
|
username: string | null
|
|
path: string
|
|
search: Record<string, string>
|
|
schemeOverride: { ssl: Scheme; noSsl: Scheme } | null
|
|
masked: boolean
|
|
},
|
|
) {}
|
|
}
|