Initial commit

src/extension/example.ts

@@ -0,0 +1,15 @@
+import type { ExampleType } from '../types/index.js';
+import { nodecg } from './util/nodecg.js';
+import { exampleReplicant } from './util/replicants.js';
+
+// Example code:
+// Log to show things are working.
+nodecg.log.info('Extension code working!');
+// Access this bundle's configuration with no type assertion needed.
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+const configProperty = nodecg.bundleConfig.exampleProperty;
+// Access/set a replicant (also see ./util/replicants).
+exampleReplicant.value = { exampleProperty: `exampleString_Changed_${Date.now()}` };
+// Accessing normal types.
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+const exampleType: ExampleType = { exampleProperty: 'exampleString' };

src/extension/index.ts

@@ -0,0 +1,12 @@
+import type { NodeCGServerAPI } from '../types/index.js';
+import { set } from './util/nodecg.js';
+
+export default async (nodecg: NodeCGServerAPI) => {
+  /**
+   * Because of how top-level `import`s work, it helps to use `import`s here
+   * to force things to be loaded *after* the NodeCG context is set.
+   */
+  set(nodecg); // set nodecg "context" before anything else
+  await import('./util/replicants.js'); // make sure replicants are set up
+  await import('./example.js');
+};

src/extension/util/nodecg.ts

@@ -0,0 +1,7 @@
+import type { NodeCGServerAPI } from '../../types/index.js';
+
+export let nodecg!: NodeCGServerAPI;
+
+export function set(ctx: NodeCGServerAPI) {
+  nodecg = ctx;
+}

src/extension/util/replicants.ts

@@ -0,0 +1,19 @@
+import type NodeCG from 'nodecg/types';
+import type { Schemas } from '../../types/index.js';
+import { nodecg } from './nodecg.js';
+
+// Wrapper for replicants that have a default (based on schema).
+function hasDefault<T>(name: string) {
+  return nodecg.Replicant<T>(name) as unknown as NodeCG.default.ServerReplicantWithSchemaDefault<T>;
+}
+// Wrapper for replicants that don't have a default (based on schema).
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+function hasNoDefault<T>(name: string) {
+  return nodecg.Replicant<T>(name) as NodeCG.default.ServerReplicant<T>;
+}
+
+/**
+ * This is where you can declare all of your replicants to import easily into other files,
+ * and to make sure they have any correct settings on startup.
+ */
+export const exampleReplicant = hasDefault<Schemas.ExampleReplicant>('exampleReplicant');