Class TapjawApiCommand Abstract

Protected Abstract getAdapterCallback

• getAdapterCallback(args: TapjawCommandArgs<unknown>, flags: TapjawCommandFlags<unknown>): TapjawAdapterCallback<TapjawMessage>

• Implement this function to return a callback that provides the implementation on how to call an adapters method. This allows for arguments and flags from this method to adjust the behaviour from the Adapter's method.

  Basic Example:

    getAdapterCallback(args: TapjawCommandArgs, flags: TapjawCommandFlags): TapjawAdapterCallback {
       return (async function* (): AsyncGenerator<TapjawMessage> {
           yield* implementedAdapter.myMethodToExecute();
       });
    }
  

  Broader Example:

    getAdapterCallback(args: TapjawCommandArgs, flags: TapjawCommandFlags): TapjawAdapterCallback {
       const category = args.category || undefined;
  
       return (async function* (): AsyncGenerator<TapjawMessage> {
           yield* implementedAdapter.myMethodToExecute(flags.onlyActiveItems, category);
       });
    }
  

  see

  TapjawAdapter

  Parameters

  • args: TapjawCommandArgs<unknown>

    TapjawCommandArgs

  • flags: TapjawCommandFlags<unknown>

    TapjawCommandFlags

  Returns TapjawAdapterCallback<TapjawMessage>

  TapjawAdapterCallback