npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

apollo-datasource-typeorm

v2.3.0

Published

An Apollo DataSource for TypeORM

Downloads

20

Readme

Apollo DataSource for TypeORM

JavaScript Style Guide QA Publish to NPM and GCR codecov

This is a TypeORM DataSource for Apollo GraphQL Servers. It was adapted from the CosmosDB DataSource

Usage

Use by creating a new class extending the TypeormDataSource, with the desired entity type. Use separate DataSources for each entity type. Initialise the class by passing the entity. Ensure that you have run createConnection before initialising your data sources since this library will use getConnection to obtain a repository. If you have multiple connections you can pass the connectionName in the data source options.

@Entity()
export class UserEntity {
  @PrimaryGeneratedColumn('increment')
  id: number

  @Column({ nullable: true })
  name: string
}

@Entity()
export class PostEntity {
  @PrimaryGeneratedColumn('increment')
  id: number

  @Column({ nullable: true })
  name: string
}

export class UserDataSource extends TypeormDataStore<UserEntity, ApolloContext> {}
export class PostsDataSource extends TypeormDataStore<PostEntity, ApolloContext> {}

const server = new ApolloServer({
  typeDefs,
  resolvers,
  dataSources: () => ({
    users: new UserDataSource(UserEntity),
    posts: new PostsDataSource(PostEntity, { connectionName: 'otherConnection' })
  })
})

Custom queries

TypeormDataSource has a findByQuery method that accepts a function taking a query builder as its only argument, which you can then build a query with. Can be used in resolvers or to create wrappers.

Example of derived class with custom query methods:

export class UserDataSource extends TypeormDataSource<UserEntity, ApolloContext> {
  async findManyByGroupId (groupId: number) {
    return this.findManyByQuery(qb => qb.where('groupId = :groupId', { groupId: 2 }).limit(2))
  }
}

Write Operations

This DataSource has some built-in mutations that can be used to create, update and delete documents.

await context.dataSources.users.createOne(userDoc)

await context.dataSources.users.updateOne(userDoc)

await context.dataSources.users.updateOnePartial(userId, { name: 'Bob' })

await context.dataSources.users.deleteOne(userId)

Batching

Batching is provided on all id-based queries by DataLoader.

Caching

Caching is available on an opt-in basis by passing a ttl option on queries.