Solid Objects

https://solidobjects.dev/
Admin
Solid Objects is a SQL-backed virtual actor library for TypeScript and Node.js that enables...
Tokens:116,280
Snippets:2,205
Trust Score:6.1
Update:4 days ago
Show doc for...
Tokens:
Raw
### Install solid-objects and run quickstart

Source: https://solidobjects.dev/docs/typescript/agents.md

Install the package and execute the quickstart command to verify concurrent call handling on a temporary SQLite database.

```bash
npm install solid-objects
npx solid-objects quickstart --yes
```

--------------------------------

### Install migrations and migrate database

Source: https://solidobjects.dev/docs/ruby/operations.md

Copy new migrations, apply them to the database, and verify the installation.

```bash
bin/rails solid_objects:install:migrations
bin/rails db:migrate
bin/rails solid_objects:doctor
```

--------------------------------

### Install industrial counter dependencies

Source: https://solidobjects.dev/5min/node

Commands to initialize a Node.js project and install the solid-objects package.

```bash
mkdir ten-minute-counter && cd ten-minute-counter
npm init -y
npm pkg set type=module
npm install solid-objects
```

--------------------------------

### Run the quickstart smoke test

Source: https://solidobjects.dev/docs/ruby/quickstart.md

Executes the automated verification suite to confirm gem installation and actor correctness.

```bash
bundle exec rake quickstart
```

--------------------------------

### Run runtime and perform operations

Source: https://solidobjects.dev/5min/node

Commands to start the runtime and execute hold/status operations.

```bash
node ticket-counter.mjs work
```

```bash
node ticket-counter.mjs hold ada
node ticket-counter.mjs status
```

--------------------------------

### Verify installation with solid_objects:doctor

Source: https://solidobjects.dev/docs/ruby/operations.md

Run the installation doctor to validate runtime configuration, tables, columns, and actor round-trips.

```bash
bin/rails solid_objects:doctor
```

--------------------------------

### Running the TicketSale example

Source: https://solidobjects.dev/docs/typescript/virtual-actors.md

Commands to install dependencies and execute the worker and hold processes in separate terminals.

```bash
npm install solid-objects
node ticket-sale.mts work
node ticket-sale.mts hold
```

--------------------------------

### GET /api/v2/ask

Source: https://solidobjects.dev/docs/ruby/quickstart.md

Searches documentation for an answer to a given question. Returns relevant documentation snippets with source links, or a message indicating no matches.

```APIDOC
## GET /api/v2/ask

### Description
Searches documentation for an answer to a given question. Returns relevant documentation snippets with source links, or a message indicating no matches.

### Method
GET

### Endpoint
https://context7.com/api/v2/ask

### Parameters
#### Query Parameters
- **siteKey** (string) - Required - The site key for the documentation site.
- **query** (string) - Required - URL-encoded question to search for.

### Response
#### Success Response (200)
- Returns documentation that answers the question, with a source link for each part.
- If nothing matches, it says so.

#### Response Example
{
  "answer": "...",
  "sources": [
    {
      "title": "...",
      "url": "..."
    }
  ]
}
```

--------------------------------

### Start the runtime process

Source: https://solidobjects.dev/docs/ruby/agents.md

Command to start the runtime process required for async calls, reminders, and effects.

```bash
bundle exec solid_objects start
```

--------------------------------

### Install and configure solid_objects

Source: https://solidobjects.dev/docs/ruby/agents.md

Run these commands to add the gem, generate necessary files, run migrations, and verify the installation.

```bash
bundle add solid_objects
bin/rails generate solid_objects:install
bin/rails db:migrate
bin/rails solid_objects:doctor
```

--------------------------------

### Start Solid Queue process

Source: https://solidobjects.dev/ruby/compare/solid-queue

Commands used to start the Solid Queue process, either via the bin/jobs executable or the Puma plugin.

```bash
bin/jobs
```

--------------------------------

### Serve the application via CLI

Source: https://solidobjects.dev/5min/browser

Use a local server to host the files, which is required for OPFS functionality.

```bash
npx --yes serve . --listen 3000
```

--------------------------------

### Create a new Rails application

Source: https://solidobjects.dev/docs/ruby/quickstart.md

Creates a new Rails application named ticket_demo and changes into its directory. Requires Ruby 3.3+, Rails 7.1+, and SQLite 3.35+.

```bash
rails new ticket_demo
cd ticket_demo
```

--------------------------------

### Start runtime with custom worker counts

Source: https://solidobjects.dev/docs/ruby/operations.md

Overrides default worker and scheduler counts via command line arguments.

```bash
bundle exec solid_objects start \
  --workers 4 \
  --effect-workers 2 \
  --broadcast-workers 2 \
  --reminder-schedulers 1
```

--------------------------------

### Configure initial authorization policies

Source: https://solidobjects.dev/docs/ruby/quickstart.md

Update the initial configuration in config/initializers/solid_objects.rb to enable message and query authorization for local development.

```ruby
configuration.authorize_message = ->(**) { false }
configuration.authorize_query = ->(**) { false }
```

```ruby
configuration.authorize_message = ->(**) { true }
configuration.authorize_query = ->(**) { true }
```

--------------------------------

### Doctor warning for denied policies

Source: https://solidobjects.dev/docs/ruby/quickstart.md

Example output from bin/rails solid_objects:doctor when the generated initializer denies every operation. The doctor reports this as a warning.

```text
WARN authorization: all five policies denied a neutral context; review the generated initializer before use
```

--------------------------------

### Install browser runtime dependencies

Source: https://solidobjects.dev/docs/typescript/agents.md

Install the required solid-objects package and the optional peer dependency for SQLite WASM.

```bash
npm install solid-objects @sqlite.org/sqlite-wasm
```

--------------------------------

### Interact with TicketSale in Rails Console

Source: https://solidobjects.dev/docs/ruby/quickstart.md

Open the Rails console and use the TicketSale actor to hold tickets and check availability.

```bash
bin/rails console
```

```ruby
sale = TicketSale.ref("concert")
sale.hold(buyer: "ada")
sale.hold(buyer: "grace")
sale.available
```

--------------------------------

### GET /api/v2/ask

Source: https://solidobjects.dev/docs/typescript/comparisons.md

Searches the documentation for the given query and returns relevant documentation snippets with source links. No API key is required.

```APIDOC
## GET /api/v2/ask

### Description
Searches the documentation for the given query and returns relevant documentation snippets with source links. No API key is required.

### Method
GET

### Endpoint
https://context7.com/api/v2/ask

### Parameters
#### Query Parameters
- **siteKey** (string) - Required - The site key for the documentation site.
- **query** (string) - Required - URL-encoded question to search for.

### Response
#### Success Response (200)
Returns documentation that answers the question, with a source link for each part. If nothing matches, it says so.

#### Response Example
(No explicit response example provided in the source.)
```
Tokens:
Raw