Users: deleteContent()

コンテンツを削除します。

この関数は非同期関数です。

構文

Users.deleteContent(userId) => Promise<boolean>
Users.deleteContent(userId, options) => Promise<boolean>

引数

  • userId: string

    ユーザの識別子です。

  • options: { [projection][, tableName] }?

    オプション引数です。

    • projection: { [key: string]: boolean | object }?

      削除したいコンテンツを指定するためのマッピングです。

      • 既定では値全体が null に置き換えられます。

    • tableName: string?

      registerTable() で登録されたテーブル名です。

      • 既定では最初に登録されたテーブルが使用されます。

返値: Promise<boolean>

削除に成功したかどうかを返すプロミスです。

例外

  • TypeError
    • userId が文字列以外だった場合。
    • options.projection がオブジェクト以外だった場合。

解説

コンテンツが値またはオブジェクトリテラルで options.projection が与えられなかった場合、その値を null に置き換えます。コンテンツがオブジェクトリテラルで、options.projection が与えられた場合、options.projection で値が true となるキーと一致したキーのコンテンツを null に置き換えます。

await Users.signup("user", { content: { password: "foo", secret: "bar" }});

await Users.deleteContent("user", { password: true });
// => { password: null, secret: "bar" }

キーが存在しなかった場合、コンテンツは変更されず false が返されます。