Skip to content
Anton Demushkin edited this page Aug 5, 2019 · 9 revisions

Welcome to the sequelize-nested-set docs!

Sequelize Nested Set - a library to store and manage nested set trees using Sequelize version 4 or 5. It supports multi-root trees.

I'm trying to keep all functions good-documented, but still I'm working on the docs to provide you more info about the functions and examples.

P.S. Don't forget star this library. It stimulates me to support the library! ⭐️

P.P.S. If you feel like you could help me with the library (writing docs, adding new features, testing, fixing bugs or anything else) - you are welcome! If you need any info or have a question, just email me at fremail@yandex.com

Methods (API)

I separated the methods into 5 categories to keep it simple. If you just want to get a full list of functions - welcome to All Methods page.

Categories of the methods:

  • Creating a record - when you want to create a new record e.g. create root or insert as first child
  • Getting records - when you want to get some records from DB; e.g. get root or get children
  • Moving a record - when you want to move an existing record; e.g. move to another parent
  • Checking a record - when you want to check a record; e.g. does it have children?
  • Destroy a record - when you want to delete the record or prepare it to move; e.g. delete or detach
Clone this wiki locally