Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ConfigProfiles

API Class for manipulating config profiles.

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected mConfig

mConfig: Config

Methods

buildProfile

  • buildProfile(path: string, profiles: {}): {}

  • Build the set of properties contained within a set of nested profiles.

    Parameters

    • path: string

      The dotted path of desired location.

    • profiles: {}

      A set of nested profile objects.

    Returns {}

    The desired profile object. An empty object if profiles is empty.

    • [key: string]: string

defaultGet

  • defaultGet(profileType: string): {}

  • Get the profile contents for the default profile of the specified type of profile within the currently active layer.

    Parameters

    • profileType: string

      The name of the desired type of profile (like zosmf).

    Returns {}

    An object containing the desired profile, for example {"host": "lpar.your.domain.net", port: 1234}

    • [key: string]: string

defaultSet

  • defaultSet(profileType: string, value: string): void

  • Set the default value for the specified type of profile within the currently active layer.

    Parameters

    • profileType: string

      The name of the desired type of profile (like zosmf).

    • value: string

      The dotted node path to the profile (like ca32.zosmf).

    Returns void

exists

  • exists(path: string): boolean

Private findProfile

get

  • get(path: string, mustExist?: boolean): {}

  • Get the profile object located at the specified location.

    Parameters

    • path: string

      The dotted path of the location at which to set the profile.

    • Optional mustExist: boolean

      If false, outer layer profile values will still be returned when the dotted path does not exist. Default is true.

    Returns {}

    • [key: string]: string

getProfileNameFromPath

  • getProfileNameFromPath(path: string): string

  • Obtain the profile name (either nested or not) based on a property path.

    note

    This may be useful for supporting token authentication in a nested configuration

    Parameters

    • path: string

      The property path.

    Returns string

    The corresponding profile name.

getProfilePathFromName

  • getProfilePathFromName(shortPath: string): string

set

Generated using TypeDoc