Options
All
  • Public
  • Public/Protected
  • All
Menu

Class KeyValue

Represents key/value pair stored in Consul

Hierarchy

  • KeyValue

Index

Constructors

Methods

Constructors

constructor

  • Returns KeyValue

  • Parameters

    Returns KeyValue

Methods

getCreateIndex

  • getCreateIndex(): number

  • Set the internal index value that represents when the entry was created.

    Returns number

getFlags

  • getFlags(): number

  • Set the flags attached to this entry. Clients can choose to use this however makes sense for their application.

    Returns number

getKey

  • getKey(): string

  • Set the key

    Returns string

getLockIndex

  • getLockIndex(): number

  • Set the number of times this key has successfully been acquired in a lock.

    Returns number

getModifyIndex

  • getModifyIndex(): number

  • Set the last index that modified this key.

    Returns number

getSession

  • getSession(): string

  • Set the session that owns the lock

    Returns string

getValue

  • getValue(): string

  • Set the value

    Returns string

setCreateIndex

  • setCreateIndex(createIndex: number): KeyValue

  • Set the internal index value that represents when the entry was created.

    Parameters

    • createIndex: number

    Returns KeyValue

setFlags

  • Set the flags attached to this entry. Clients can choose to use this however makes sense for their application.

    Parameters

    • flags: number

    Returns KeyValue

setKey

  • Set the key

    Parameters

    • key: string

    Returns KeyValue

setLockIndex

  • setLockIndex(lockIndex: number): KeyValue

  • Set the number of times this key has successfully been acquired in a lock.

    Parameters

    • lockIndex: number

    Returns KeyValue

setModifyIndex

  • setModifyIndex(modifyIndex: number): KeyValue

  • Set the last index that modified this key.

    Parameters

    • modifyIndex: number

    Returns KeyValue

setSession

  • Set the session that owns the lock

    Parameters

    • session: string

    Returns KeyValue

setValue

  • Set the value

    Parameters

    • value: string

    Returns KeyValue

toJson

  • toJson(): {}

  • Returns {}

    • [key: string]: any

Generated using TypeDoc