@zsnout/core v1.0.13

This module creates a Fastify server with a Socket.IO server attatched. Additionally, it exports simple functions for serving directories and adding database/mail providers.

• JavaScript API
  • server: FastifyInstance
    • server.database: DatabaseProvider
    • server.mailer: MailProvider
    • server.io: SocketIOInstance<IOEvents, IOEvents, IOServerEvents>
  • listen(port: number, host?: string, backlog?: number): Promise<void>
  • addProvider<T extends keyof Providers>(type: T, provider: Providers[T]): void
  • hasProvider(type: keyof Providers): boolean
  • onProvider(type: keyof Providers): boolean
  • serveDirectory(root: string, prefix?: string): void
• TypeScript API
  • interface Collection<T extends Table>
    • Collection.find(query: Partial<T>): Promise<readonly Readonly[]>
    • Collection.insert(...documents: T[]): Promise<void>
    • Collection.update(query: Partial<T>, data: Partial<T>): Promise<void>
    • Collection.delete(query: Partial<T>): Promise<void>
  • interface Database extends StructuredDatabase
  • interface DatabaseProvider
    • DatabaseProvider.collection<T extends keyof Database>(table: T): Promise<Collection<Database[T]>>
  • interface IOEvents
  • interface IOServerEvents
  • interface MailProvider
  • interface Providers
  • interface Table
  • type StructuredDatabase = { [table: string]: Table }

JavaScript API

server: FastifyInstance

The main Fastify server.

server.database: DatabaseProvider

The server's database provider. See interface DatabaseProvider for more information.

NOTICE: This property may not exist. To check if a database provider has been added using addProvider(), use hasProvider() or onProvider().

server.mailer: MailProvider

The server's mail provider. See interface MailProvider for more information.

NOTICE: This property may not exist. To check if a mail provider has been added using addProvider(), use hasProvider() or onProvider().

server.io: SocketIOInstance<IOEvents, IOEvents, IOServerEvents>

The server's Socket.IO instance.

listen(port: number, host?: string, backlog?: number): Promise<void>

Starts listening for connections on the server instance. Returns a promise that resolves once the server accepts connections.

• port: number - The port to listen on.
• host?: string - The host to listen on.
• backlog?: number - The number of connections to backlog before refusing new connections.

addProvider<T extends keyof Providers>(type: T, provider: ProvidersT): void

This function is also added as a server instance method as server.addProvider.

Adds a database or mail provider to the server instance.

• type: T - The type of provider to add.
• provider: Providers[T] - The provider to add.

hasProvider(type: keyof Providers): boolean

This function is also added as a server instance method as server.hasProvider.

Checks if a provider has been added to the server instance. Returns a boolean indicating if the server has the provider.

• type: keyof Providers - The type of provider to check for.

onProvider(type: keyof Providers): boolean

This function is also added as a server instance method as server.onProvider.

Waits for a provider to be added to the server instance. A boolean indicating if the server has the provider.

• type: keyof Providers - The type of provider to wait for.

serveDirectory(root: string, prefix?: string): void

This function is also added as a server instance method as server.serveDirectory.

Serves a directory of static files.

• root: string - A path to the directory containing files to send to the client.
• prefix?: string - An optional prefix to serve files under.

TypeScript API

interface Collection<T extends Table>

An interface all database collections must implement.

Collection.find(query: Partial<T>): Promise<readonly Readonly[]>

Find documents in the collection. Returns a promise resolving to an array of documents.

• query: Partial<T> - A filter to match documents against.

Collection.insert(...documents: T[]): Promise<void>

Inserts documents into the collection. Returns a promise resolving once the documents have been inserted.

• ...documents: T[] - The documents to insert.

Collection.update(query: Partial<T>, data: Partial<T>): Promise<void>

Updates documents in the collection. Returns a promise resolving once the documents have been updated.

• query: Partial<T> - A filter to match documents against.
• data: Partial<T> - The data to update the documents with.

Collection.delete(query: Partial<T>): Promise<void>

Deletes documents from the collection. Returns a promise resolving once the documents have been deleted.

• query: Partial<T> - A filter to match documents against.

interface Database extends StructuredDatabase

A list of collections in the main database. Used for autocomplete.

interface DatabaseProvider

The interface a database provider must implement.

DatabaseProvider.collection<T extends keyof Database>(table: T): Promise<Collection<DatabaseT>>

Gets a collection from the database. Returns a promise resolving with a collection instance for the given table.

• table: T - The name of the collection to get.

interface IOEvents

A collection of client events that can be used by the socket.io instance.

interface IOServerEvents

A collection of server events that can be used by the socket.io instance.

interface MailProvider

An interface all mail providers must implement.

interface Providers

A list of providers that can be added to the server instance.

interface Table

A type alias for a database table.

type StructuredDatabase = { table: string: Table }

The base structure for a database.