feat: added optional instance setting to allow consumers to choose si…

[eacaps]

I'm not thrilled with how this turned out, and I think the typing of IOrbViewSettingsInit might be slightly off now, so please let me know if you'd like me to make adjustments

[tonilastre]

Looks great! I've just added a few comments regarding the Typescript and lint. Let me know what you think.

[tonilastre]

Suggested change

	> & { render?: Partial<IRendererSettingsInit> } & {
	instances: {
	simulator?: ISimulator | (() => ISimulator);
	};
	> & {
	render?: Partial<IRendererSettingsInit>,
	instances?: {
	simulator?: ISimulator | (() => ISimulator);
	};

I would say that you don't need to join them with & - just append to the render interface. Btw instances should be optional, if not users would need to always initiate an empty object even if they don't want to override the simulator instance.

[tonilastre]

Hmm, I think lint is not working for you because this should be indented + if should be wrapped in brackets. Can you check if husky is initialized and npm run lint / npm run lint:fix works.

Also, there is a cool Typescript trick you can use here:

type ICallbackOrInstance<T> = T | (() => T);

export type IOrbViewSettingsInit<N extends INodeBase, E extends IEdgeBase> = Omit<
  ...
  instances?: {
    simulator?: ICallbackOrInstance<ISimulator>;
  };
}


private _createSimulator(simulator?: ICallbackOrInstance<ISimulator>): ISimulator {
   ...
}

[eacaps]

yeah that definitely looks nicer. is there a cleaner way to do the type check instead of

 if(typeof simulator === "function")  return simulator();

[tonilastre]

I think that is the most clean way to check for the function. You could have a util function somewhere. Just as I wrote this comment to give you a link to which place is the best to have a utility function in, I found a function:

https://github.com/memgraph/orb/blob/main/src/utils/type.utils.ts#L87

You already have isFunction type guard check so you can use it here :)

[CLAassistant]

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.

---

ecapito seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
_{You have signed the CLA already but the status is still pending? Let us recheck it.}