API Reference

Core API

NexaSpace

The main application class.

Constructor

new NexaSpace(options?: NexaSpaceOptions)

Options:

Parameter	Type	Default	Description
production	boolean	false	Enable production mode
port	number	3000	Server port
host	string	'localhost'	Server host
cache	CacheOptions	{}	Cache configuration
logging	LogOptions	{}	Logging configuration

Example:

const app = new NexaSpace({
  production: true,
  port: 8080,
  cache: { enabled: true }
});

---

HTTP Methods

app.get()

Register a GET route handler.

app.get(path: string, ...handlers: Handler[]): void

Parameters:

• path - Route path (supports parameters like /users/:id)
• handlers - One or more request handlers

Example:

app.get('/users/:id', async (req, res) => {
  const user = await db.users.findById(req.params.id);
  res.json(user);
});

app.post()

Register a POST route handler.

app.post(path: string, ...handlers: Handler[]): void

app.put()

Register a PUT route handler.

app.put(path: string, ...handlers: Handler[]): void

app.delete()

Register a DELETE route handler.

app.delete(path: string, ...handlers: Handler[]): void

---

Middleware

app.use()

Register middleware or plugin.

app.use(middleware: Middleware | Plugin): void

Example:

// Custom middleware
app.use((req, res, next) => {
  console.log(`${req.method} ${req.path}`);
  next();
});

// Plugin
import { CORS } from 'nexaspace';
app.use(CORS());

---

Request Object

The request object represents the HTTP request.

Properties

Property	Type	Description
body	any	Parsed request body
params	Record<string, string>	URL parameters
query	Record<string, string>	Query string parameters
headers	Record<string, string>	Request headers
method	string	HTTP method
path	string	Request path
ip	string	Client IP address
user	User | null	Authenticated user (if auth middleware is used)

Methods

req.get()

Get request header value.

req.get(name: string): string | undefined

Example:

const contentType = req.get('content-type');
const auth = req.get('authorization');

---

Response Object

The response object represents the HTTP response.

Methods

res.json()

Send JSON response.

res.json(data: any, status?: number): void

Example:

res.json({ success: true, data: users });
res.json({ error: 'Not found' }, 404);

res.send()

Send text response.

res.send(data: string, status?: number): void

res.status()

Set response status code.

res.status(code: number): Response

Example:

res.status(201).json({ created: true });

res.redirect()

Redirect to another URL.

res.redirect(url: string, status?: number): void

---

Authentication

JWTAuth

JWT authentication middleware.

JWTAuth()

Configure JWT authentication.

JWTAuth(options: JWTOptions): Middleware

Options:

Parameter	Type	Required	Description
secret	string	Yes	JWT secret key
expiresIn	string	No	Token expiration (e.g., ‘7d’)
algorithms	string[]	No	Allowed algorithms

JWTAuth.sign()

Generate JWT token.

JWTAuth.sign(payload: object, expiresIn?: string): string

Example:

const token = JWTAuth.sign(
  { userId: user.id, role: user.role },
  '24h'
);

JWTAuth.require()

Middleware to require authentication.

JWTAuth.require(): Middleware

---

Database

Database Connection

import { Database } from 'nexaspace';

const db = new Database({
  type: 'postgresql',
  host: 'localhost',
  port: 5432,
  database: 'nexaspace',
  username: 'user',
  password: 'pass'
});

Query Methods

db.query()

Execute raw SQL query.

db.query<T>(sql: string, params?: any[]): Promise<T[]>

db.insert()

Insert record.

db.insert(table: string, data: object): Promise<number>

db.update()

Update records.

db.update(table: string, data: object, where: object): Promise<number>

db.delete()

Delete records.

db.delete(table: string, where: object): Promise<number>

---

Cache

Cache Configuration

import { Cache } from 'nexaspace';

const cache = new Cache({
  type: 'redis',
  host: 'localhost',
  port: 6379,
  ttl: 3600 // Default TTL in seconds
});

Methods

cache.get()

Get cached value.

cache.get<T>(key: string): Promise<T | null>

cache.set()

Set cached value.

cache.set(key: string, value: any, ttl?: number): Promise<void>

cache.del()

Delete cached value.

cache.del(key: string): Promise<void>

cache.clear()

Clear all cached values.

cache.clear(): Promise<void>

---

Type Definitions

Handler

Request handler function type.

type Handler = (
  req: Request,
  res: Response,
  next?: NextFunction
) => void | Promise<void>

Middleware

Middleware function type.

type Middleware = (
  req: Request,
  res: Response,
  next: NextFunction
) => void | Promise<void>

NextFunction

Next middleware function type.

type NextFunction = (error?: Error) => void