Options
All
  • Public
  • Public/Protected
  • All
Menu

External module ExtractUids

Index

Functions

xExtractFirstUid

  • xExtractFirstUid(mutation: Promise<Assigned>): Promise<string>
  • xExtractFirstUid(mutation: Assigned): string
  • xExtractFirstUid is useful when you expect only one value and dont want to destructure the returned array. It's effectively just xExtractUids limited to one result

    const users = [
     { username: 'foo' }
     { username: 'bar' }
    ]
    
    // Wrapping the xSetJSONCommitTxn promise. Nice.
    const id1 = await xExtractFirstUid(xSetJSONCommitTxn(users, dgraphClient));

    Parameters

    • mutation: Promise<Assigned>

    Returns Promise<string>

  • Parameters

    • mutation: Assigned

    Returns string

xExtractNamedUids

  • xExtractNamedUids(names: string[], mutation: Promise<Assigned>): Promise<string[]>
  • xExtractNamedUids(names: string[], mutation: Assigned): string[]
  • xExtractNamedUids lets you wrap any of the set commands that return a dgraph assigned value or a promise that returns a dgraph assigned value

    const sampleData = {
    uid: "_:user",
    name: "cameron",
    username: "vespertilian",
     address: {
      uid: "_:address",
      street: 'William',
      postCode: 2000
     }
    };
    
    // Wrapping the xSetJSONCommitTxn promise. Nice.
    const [userId, addressId] = await xExtractNamedUids(['user', 'address'], xSetJSONCommitTxn(sampleData, dgraphClient))

    Parameters

    • names: string[]
    • mutation: Promise<Assigned>

    Returns Promise<string[]>

  • Parameters

    • names: string[]
    • mutation: Assigned

    Returns string[]

xExtractUids

  • xExtractUids(mutation: Promise<Assigned>, limitTo?: number): Promise<string[]>
  • xExtractUids(mutation: Assigned, limitTo?: number): string[]
  • xExtractUids lets you wrap any of the set commands that return a dgraph assigned value or a promise that returns a dgraph assigned value

    const users = [
     { username: 'foo' }
     { username: 'bar' }
    ]
    
    // Wrapping the xSetJSONCommitTxn promise. Nice.
    const [id1, id2] = await xExtractUids(xSetJSONCommitTxn(users, dgraphClient));

    Parameters

    • mutation: Promise<Assigned>
    • Optional limitTo: number

    Returns Promise<string[]>

  • Parameters

    • mutation: Assigned
    • Optional limitTo: number

    Returns string[]

Generated using TypeDoc