https://github.com/stagas/plugs-and-cables

Plugs and cables.
https://github.com/stagas/plugs-and-cables

Last synced: 14 days ago
JSON representation

Plugs and cables.

• Host: GitHub
• URL: https://github.com/stagas/plugs-and-cables
• Owner: stagas
• License: mit
• Created: 2022-06-07T18:06:58.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-08-01T14:15:19.000Z (over 2 years ago)
• Last Synced: 2024-10-22T17:47:41.638Z (23 days ago)
• Language: TypeScript
• Size: 8.79 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


plugs-and-cables    





Plugs and cables.





npm i plugs-and-cables 


pnpm add plugs-and-cables 

yarn add plugs-and-cables

## API

  #  PlugKind      src/plugs-and-cables.ts#L4  
        
  #  Input   =   "input"    src/plugs-and-cables.ts#L5  
        
#  Output   =   "output"    src/plugs-and-cables.ts#L6  
        


#  Cable      src/plugs-and-cables.ts#L62  
        
  #  constructor(cable)      src/plugs-and-cables.ts#L68  
    
  #  new Cable()        


Cable
      
  #  cable        


Cable
        
  
#  new Cable()        


Cable
      
  #  outputCh        


number
        
#  inputCh        


number
        
  
    
#  id   =   ...    src/plugs-and-cables.ts#L63  


string
        
#  inputCh      src/plugs-and-cables.ts#L66  


number
        
#  outputCh      src/plugs-and-cables.ts#L65  


number
        


#  Plug      src/plugs-and-cables.ts#L9  
        
  #  constructor(plug)      src/plugs-and-cables.ts#L21  
    
  #  new Plug()        


Plug<P, C>
      
  #  plug        


Plug<P, C>
        
  
#  new Plug()        


Plug<P, C>
      
  #  plugKind        


Plug<P, C> | P
        
#  cableKind        


C
        
  
    
#  cableKind      src/plugs-and-cables.ts#L14  


C
        
#  cables   =   ...    src/plugs-and-cables.ts#L16  


Map<Cable, Plug<P extends Output ? Input : Output, C>>
        
#  onconnect      src/plugs-and-cables.ts#L18  


EventHandler<Plug<any, any>, CustomEvent<{

  #  cable      src/plugs-and-cables.ts#L18  


Cable
        
#  plug      src/plugs-and-cables.ts#L18  


Plug<any, any>
        
}>>
        
#  ondisconnect      src/plugs-and-cables.ts#L19  


EventHandler<Plug<any, any>, CustomEvent<{

  #  cable      src/plugs-and-cables.ts#L19  


Cable
        
#  plug      src/plugs-and-cables.ts#L19  


Plug<any, any>
        
}>>
        #  plugKind      src/plugs-and-cables.ts#L13  


P
        
#  Input   =   ...    src/plugs-and-cables.ts#L11  


Input
        
#  Output   =   ...    src/plugs-and-cables.ts#L10  


Output
        
#  connect(this, other, cable)      src/plugs-and-cables.ts#L41  
    
    #  this        


Plug<any, any>
        
#  other        


Plug<any, any>
        
#  cable   =   ...      


Cable
        
  


connect(this, other, cable)   =>  

Cable
    
#  disconnect(this, cable)      src/plugs-and-cables.ts#L49  
    
    #  this        


Plug<any, any>
        
#  cable        


Cable
        
  


disconnect(this, cable)   =>  

Cable
    


## Credits

- [event-toolkit](https://npmjs.org/package/event-toolkit) by [stagas](https://github.com/stagas) – Toolkit for DOM events.

- [everyday-utils](https://npmjs.org/package/everyday-utils) by [stagas](https://github.com/stagas) – Everyday utilities

## Contributing

[Fork](https://github.com/stagas/plugs-and-cables/fork) or [edit](https://github.dev/stagas/plugs-and-cables) and submit a PR.

All contributions are welcome!

## License

MIT © 2022 [stagas](https://github.com/stagas)