Browse Source

docs(core): Add some missing docs

Michael Bromley 2 years ago
parent
commit
9a3394fe45

+ 9 - 0
packages/core/src/entity/channel/channel.entity.ts

@@ -37,9 +37,18 @@ export class Channel extends VendureEntity {
         }
         }
     }
     }
 
 
+    /**
+     * @description
+     * The name of the Channel. For example "US Webstore" or "German Webstore".
+     */
     @Column({ unique: true })
     @Column({ unique: true })
     code: string;
     code: string;
 
 
+    /**
+     * @description
+     * A unique token (string) used to identify the Channel in the `vendure-token` header of the
+     * GraphQL API requests.
+     */
     @Column({ unique: true })
     @Column({ unique: true })
     token: string;
     token: string;
 
 

+ 1 - 0
packages/job-queue-plugin/src/bullmq/plugin.ts

@@ -43,6 +43,7 @@ import { BullMQPluginOptions } from './types';
  * const config: VendureConfig = {
  * const config: VendureConfig = {
  *   // Add an instance of the plugin to the plugins array
  *   // Add an instance of the plugin to the plugins array
  *   plugins: [
  *   plugins: [
+ *     // DefaultJobQueuePlugin should be removed from the plugins array
  *     BullMQJobQueuePlugin.init({
  *     BullMQJobQueuePlugin.init({
  *       connection: {
  *       connection: {
  *         port: 6379
  *         port: 6379