Skip to content
This repository has been archived by the owner on Jan 31, 2023. It is now read-only.

Latest commit

 

History

History
12 lines (10 loc) · 1.62 KB

glossary.md

File metadata and controls

12 lines (10 loc) · 1.62 KB
Raw

Glossary

Since so many terms are thrown around in the documentation and comments within the codebase below is a short glossary to ensure everyone is talking about the same thing.

  • Original Atom Server / Atom.io Server: The Backend Package Repository Server that was built, maintianed, and sunset by Atom/GitHub/Microsoft. This server we have no access to, and has no source available. We are only able to learn about it by interactions with it, and the interactions baked into the source code of tools that rely on it.
  • Atom Backend / Pulsar Backend: The new Open Source creation of the Package Repository Server. Where within Pulsar environments it's referred to simply as the Pulsar Package Repository.
  • Server Status Object: The object most modules return within in the codebase, more details are available.
  • Package Object Full: The largest form of Package data returned to end users, more details are available.
  • Package Object Short: The most common form of Package data returned to end users, more details are available.
  • Package Object Mini: The smallest possible return of Package data returned to end users, more details are available.
  • User Object: The only form of data returned to end users that contains user data, more details are available.
  • Bubbled Errors: The act of letting an error be easily caught and letting it bubble up from lower level modules back to the end users to ensure they see a proper report of what went wrong, more details are available.