API Reference

Welcome to the complete API reference for the @blocklet/server-js. This section provides detailed documentation for every GraphQL query, mutation, and type available through the Blocklet Server Client. Whether you need to fetch data, modify server state, or understand the structure of the data you're working with, this is your comprehensive guide.

The API is organized into three main categories:

Queries#

Queries are used to read or fetch data from the Blocklet Server. The Blocklet Server Client provides a set of convenient methods that wrap these GraphQL queries, making it easy to retrieve information without writing raw GraphQL. These methods cover a wide range of functionalities, from checking the node's status to fetching detailed user information.

For a complete list of all available query methods and their detailed documentation, please visit the Queries section.

Mutations#

Mutations are used to modify server-side data. This includes actions like creating, updating, or deleting resources. The Blocklet Server Client offers a comprehensive set of mutation methods that allow you to manage the entire lifecycle of your blocklets, users, and other server resources programmatically.

For a complete list of all available mutation methods and their detailed documentation, please visit the Mutations section.

Types#

Types define the structure of the data you can query and send. This includes object types, input types, and enums. Understanding these types is crucial for effectively using the API, as they dictate the shape of the data in both requests and responses.

For a complete reference of all data types used in the API, please visit the Types section.