Skip to content

Start here

concept
3 min readUpdated

NestJS head-to-head

What this repository is for is not stated in prose this page can quote, so it cannot be established from this repository alone.

  • Terms of use — MIT [package.json:14].
  • Version11.1.26 [package.json:3].
  • Editions — whether this repository is the whole product or one edition of it cannot be established from this repository alone.
  • Running it — no run path was found in the parsed corpus, so how to start it cannot be established from this repository alone.

What is in here

Each part names what it holds before how much of it there is. The counts are read from the evidence census computed for this snapshot, one per part at most.

  • Common — decorators, exceptions, pipes, features; services. A file to open: class-serializer.interceptor.ts [packages/common/serializer/class-serializer.interceptor.ts:34]. 353 entities under packages/common [census].
  • Core — injector, router, errors, inspector; HTTP endpoints and middleware. A file to open: container.ts [packages/core/middleware/container.ts:27]. 284 entities under packages/core [census].
  • Websockets — decorators, context, exceptions, hooks; enum and type alia. A file to open: ws-adapter.ts [packages/websockets/adapters/ws-adapter.ts:8]. 87 entities under packages/websockets [census].
  • Microservices — external, decorators, events, errors; HTTP endpoints and module. A file to open: server.ts [packages/microservices/server/server.ts:150]. 429 entities under packages/microservices [census].
  • Platform Express — multer, adapters; module. A file to open: multer.module.ts [packages/platform-express/multer/multer.module.ts:14]. 52 entities under packages/platform-express [census].
  • Platform Fastify — external, decorators, adapters; type aliases and class. A file to open: fastify-adapter.ts [packages/platform-fastify/adapters/fastify-adapter.ts:124]. 44 entities under packages/platform-fastify [census].
  • Testing — services; type aliases and classes. A file to open: mock-factory.ts [packages/testing/interfaces/mock-factory.ts:3]. 41 entities under packages/testing [census].
  • Platform Socket.io — adapters; class. A file to open: io-adapter.ts [packages/platform-socket.io/adapters/io-adapter.ts:14]. 31 entities under packages/platform-socket.io [census].
  • Platform Ws — adapters; class. A file to open: ws-adapter.ts [packages/platform-ws/adapters/ws-adapter.ts:39]. 31 entities under packages/platform-ws [census].
  • Repository root and unclaimed files — .github, tools, hooks; constants and functions. A file to open: PULL_REQUEST_TEMPLATE.md [.github/PULL_REQUEST_TEMPLATE.md:1]. 168 entities in files no part claims [census].

Trust and security, as the code carries it

Topics below come from sweeping symbol names and file paths in the parsed corpus. They are not read from a security document: a page that takes its topics from what a document enumerates inherits whatever that document left out.

  • AuthenticationSession [packages/common/decorators/http/route-params.decorator.ts:164], OauthbearerProviderResponse [packages/microservices/external/kafka.interface.ts:85].
  • AuthorizationGUARDS_METADATA [packages/common/constants.ts:23], SCOPE_OPTIONS_METADATA [packages/common/constants.ts:16], UseGuards [packages/common/decorators/core/use-guards.decorator.ts:28].
  • Secrets and configurationInjectionToken [packages/common/interfaces/modules/injection-token.interface.ts:7], generateOptionsInjectionToken [packages/common/module-utils/utils/generate-options-injection-token.util.ts:3], ENHANCER_TOKEN_TO_SUBTYPE_MAP [packages/core/constants.ts:17].
  • Transport and browser boundariesHttpStatus [packages/common/enums/http-status.enum.ts:4], CorsOptions [packages/common/interfaces/external/cors-options.interface.ts:23], CorsOptionsCallback [packages/common/interfaces/external/cors-options.interface.ts:58].
  • Input validationPIPES_METADATA [packages/common/constants.ts:22], UsePipes [packages/common/decorators/core/use-pipes.decorator.ts:29], ValidationError [packages/common/interfaces/external/validation-error.interface.ts:9].
  • CryptographyDeepHashedModuleOpaqueKeyFactory [packages/core/injector/opaque-key-factory/deep-hashed-module-opaque-key-factory.ts:13].

No symbol name or path in the parsed corpus matched rate limiting and abuse and audit and access logging. That is a statement about the names this codebase uses, not a finding about what it does.

What this repository carries

One row per capability lane, scoped to where the evidence for it sits. A lane marked as not found means nothing in the parsed corpus matched it — which is a fact about this parse, and the honest place to start looking rather than the end of the question.

CapabilityIn this repositoryWhere
Database models0 [census]
HTTP endpoints9 [census]packages/core/middleware/container.ts, packages/core/middleware/middleware-module.ts
Controllers0 [census]
Configurationnot found
Automated testsyes
Written documentationyes.github/PULL_REQUEST_TEMPLATE.md, CODE_OF_CONDUCT.md
LicenceyesLICENSE

Where next

Five ways in. Each one names pages that exist in this documentation, or says what the repository holds instead.

  • Deploying it — no deployment descriptor and no deployment page were found; how this is deployed cannot be established from this repository alone.
  • Understanding the architectureSystem Overview, Common, Core and Websockets.
  • Contributing a changeDocumentation health and [CONTRIBUTING.md:1].
  • Reviewing security — the topics above, starting at [packages/common/decorators/http/route-params.decorator.ts:164].
  • Extending itCore and Microservices.

How this page was assembled

Every count above is read from the evidence census computed for this snapshot; every other claim points at a file and a line you can open.

The census covers 1520 entities and 2691 relationships across 10 parts [census], and it passed its own independent recount [census].

Was this page helpful?

Download as PDF
Start here — NestJS head-to-head