Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CouchbaseSet

CouchbaseSet provides a simplified interface for storing a set within a Couchbase document.

see

Collection.set

Hierarchy

  • CouchbaseSet

Index

Methods

Methods

add

  • add(item: any, callback?: NodeCallback<boolean>): Promise<boolean>

  • Adds a new item to the set. Returning whether the item already existed in the set or not.

    Parameters

    • item: any

      The item to add.

    • Optional callback: NodeCallback<boolean>

      A node-style callback to be invoked after execution.

    Returns Promise<boolean>

contains

  • contains(item: any, callback?: NodeCallback<boolean>): Promise<boolean>

  • Returns whether a specific value already exists in the set.

    Parameters

    • item: any

      The value to search for.

    • Optional callback: NodeCallback<boolean>

      A node-style callback to be invoked after execution.

    Returns Promise<boolean>

remove

  • remove(item: any, callback?: NodeCallback<void>): Promise<void>

  • Removes a specific value from the set.

    Parameters

    • item: any

      The value to remove.

    • Optional callback: NodeCallback<void>

      A node-style callback to be invoked after execution.

    Returns Promise<void>

size

  • Returns the number of elements in this set.

    Parameters

    • Optional callback: NodeCallback<number>

      A node-style callback to be invoked after execution.

    Returns Promise<number>

values

  • Returns a list of all values in the set.

    Parameters

    • Optional callback: NodeCallback<any[]>

      A node-style callback to be invoked after execution.

    Returns Promise<any[]>

Generated using TypeDoc