Module "framework/api/document/membership"

Const membership

• membership(this: Biota, collectionName: string | Expr, id: string | Expr): { assignee: any; role: any; owner: object }

• Parameters

  • this: Biota

  • collectionName: string | Expr

  • id: string | Expr

  Returns { assignee: any; role: any; owner: object }

  • assignee: function

    • assignee(assignee: Expr | { id: FaunaId; ref: FaunaRefCollection }): { remove: any; set: any }

    • Parameters

      • assignee: Expr | { id: FaunaId; ref: FaunaRefCollection }

      Returns { remove: any; set: any }

      • remove: function

        • remove(): Promise<any>

        • Returns Promise<any>

      • set: function

        • set(): Promise<any>

        • Returns Promise<any>

  • role: function

    • role(roleOrRef: string | Expr | { id: FaunaId; ref: FaunaRefCollection }): { remove: any; set: any }

    • Parameters

      • roleOrRef: string | Expr | { id: FaunaId; ref: FaunaRefCollection }

      Returns { remove: any; set: any }

      • remove: function

        • remove(): Promise<any>

        • Returns Promise<any>

      • set: function

        • set(): Promise<any>

        • Returns Promise<any>

  • owner: object

    • remove: function

      • remove(owner: string | Expr | { id: FaunaId; ref: FaunaRefCollection }): Promise<any>

      • Parameters

        • owner: string | Expr | { id: FaunaId; ref: FaunaRefCollection }

        Returns Promise<any>

    • set: function

      • set(owner: string | Expr | { id: FaunaId; ref: FaunaRefCollection }): Promise<any>

      • Parameters

        • owner: string | Expr | { id: FaunaId; ref: FaunaRefCollection }

        Returns Promise<any>