Logo for jsDocs.io

postgraphile

  • Version 5.0.1
  • Published
  • 157 kB
  • 20 dependencies
  • MIT license

Install

npm i postgraphile
yarn add postgraphile
pnpm add postgraphile

Overview

Automatic, high performance, and highly customizable GraphQL API for PostgreSQL

Index

Functions

Interfaces

Functions

function postgraphile

postgraphile: (preset: GraphileConfig.Preset) => PostGraphileInstance;

    Interfaces

    interface PostGraphileInstance

    interface PostGraphileInstance {}

      method createServ

      createServ: <TGrafserv extends GrafservBase>(
          grafserv: (config: GrafservConfig) => TGrafserv
      ) => TGrafserv;

        method getResolvedPreset

        getResolvedPreset: () => GraphileConfig.ResolvedPreset;

          method getSchema

          getSchema: () => PromiseOrDirect<GraphQLSchema>;

            method getSchemaResult

            getSchemaResult: () => PromiseOrDirect<SchemaResult>;

              method release

              release: () => PromiseOrDirect<void>;

                Package Files (1)

                Dependencies (20)

                Dev Dependencies (0)

                No dev dependencies.

                Peer Dependencies (12)

                Badge

                To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/postgraphile.

                • Markdown
                  [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/postgraphile)
                • HTML
                  <a href="https://www.jsdocs.io/package/postgraphile"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>