TileJS
TileJS
Database

Instalação

Instale o TileJS Database no seu projeto

Instalação

O @tilejs/database pode ser instalado utilizando qualquer gerenciador de pacotes compatível com o Node.js ou Bun.

É recomendado utilizar a versão mais recente do pacote para aproveitar novos recursos e correções.


Instale o pacote

bun add @tilejs/database
npm install @tilejs/database
pnpm add @tilejs/database
yarn add @tilejs/database

Requisitos

RequisitoVersão
Node.js>= 24.x
Bun>= 1.x
TypeScript>= 5.x

Verificando a instalação

Crie um arquivo chamado index.ts e importe o pacote:

index.ts
import { Database, Schema } from "@tilejs/database";

console.log("TileJS Database instalado com sucesso!");

Execute:

bun index.ts
node index.ts

Se nenhuma mensagem de erro aparecer, a instalação foi concluída corretamente.


Estrutura do projeto

Antes da primeira execução:

index.ts
package.json
tsconfig.json

Após criar sua primeira Database, a pasta .tile será criada automaticamente.


O que é criado?

Na primeira vez que uma coleção é criada, o TileJS gera automaticamente toda a estrutura necessária para armazenar os dados.

Isso inclui:

  • A pasta .tile
  • A database
  • As collections
  • Os arquivos de schema
  • Os índices únicos (unique)

Você não precisa criar nenhum desses arquivos manualmente.

O TileJS utiliza arquivos BSON para armazenar documentos e arquivos JSON para metadados e índices, permitindo um banco de dados leve e portátil.


Próximo passo

Agora que o pacote está instalado, o próximo passo é criar sua primeira conexão com a database.

On this page