❤
npm
Sign UpSign In

vite-open
TypeScript icon, indicating that this package has built-in type declarations

3.1.0 • Public • Published

vite-open

Open any file directly in a Vite dev server.

npm i vite-open -g pnpm add vite-open -g yarn global add vite-open

CLI

Features

  • Zero config, zero setup. Open .js .jsx .ts .tsx .md and .html files directly.
  • Vite configured for development, all ESNext features and accurate sourcemaps.
  • Strict CORS headers enabling all Web features.
  • Compile time pattern-based debugging using rollup-plugin-debug.
  • Open files in VSCode by clicking links directly in Chrome DevTools using the open-in-editor Chrome extension (installed separately).
  • QR code display with the external address for easy access by phone.

API

# "node:stream/consumers" src/.fastpm/-/@types/node@17.0.45/stream/consumers.d.ts#L22

# blob(stream) src/.fastpm/-/@types/node@17.0.45/stream/consumers.d.ts#L19
# buffer(stream) src/.fastpm/-/@types/node@17.0.45/stream/consumers.d.ts#L16
# json(stream) src/.fastpm/-/@types/node@17.0.45/stream/consumers.d.ts#L20
# text(stream) src/.fastpm/-/@types/node@17.0.45/stream/consumers.d.ts#L17
# "node:stream/promises" src/.fastpm/-/@types/node@17.0.45/stream/promises.d.ts#L40
# pipeline(source, destination, options) src/.fastpm/-/@types/node@17.0.45/stream/promises.d.ts#L4
# EventEmitter src/.fastpm/-/@types/node@17.0.45/events.d.ts#L310
# addListener(eventName, listener) – Alias for emitter.on(eventName, listener).

    # eventName

      string | symbol

    # listener(args)

      # args

        any []

      listener(args)  =>

        void

addListener(eventName, listener)  =>

# emit(eventName, args) – Synchronously calls each of the listeners registered for the event namedeventName, in the order they were registered, passing the supplied arguments to each.

    Returns true if the event had listeners, false otherwise.

const EventEmitter = require('events')
const myEmitter = new EventEmitter()

// First listener
myEmitter.on('event', function firstListener() {
  console.log('Helloooo! first listener')
})
// Second listener
myEmitter.on('event', function secondListener(arg1, arg2) {
  console.log(`event with parameters ${arg1}, ${arg2} in second listener`)
})
// Third listener
myEmitter.on('event', function thirdListener(...args) {
  const parameters = args.join(', ')
  console.log(`event with parameters ${parameters} in third listener`)
})

console.log(myEmitter.listeners('event'))

myEmitter.emit('event', 1, 2, 3, 4, 5)

// Prints:
// [
//   [Function: firstListener],
//   [Function: secondListener],
//   [Function: thirdListener]
// ]
// Helloooo! first listener
// event with parameters 1, 2 in second listener
// event with parameters 1, 2, 3, 4, 5 in third listener
# eventName

    string | symbol

# args

    any []

emit(eventName, args)  =>

    boolean
# eventNames() – Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or Symbols. 

const EventEmitter = require('events')
const myEE = new EventEmitter()
myEE.on('foo', () => {})
myEE.on('bar', () => {})

const sym = Symbol('symbol')
myEE.on(sym, () => {})

console.log(myEE.eventNames())
// Prints: [ 'foo', 'bar', Symbol(symbol) ]

eventNames()  =>

    string | symbol []
# getMaxListeners() – Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to {@link defaultMaxListeners}.

    getMaxListeners()  =>

      number
# listenerCount(eventName) – Returns the number of listeners listening to the event named eventName.

    # eventName – The name of the event being listened for

      string | symbol

    listenerCount(eventName)  =>

      number
# listeners(eventName) – Returns a copy of the array of listeners for the event named eventName. 

server.on('connection', stream => {
  console.log('someone connected!')
})
console.log(util.inspect(server.listeners('connection')))
// Prints: [ [Function] ]
# eventName

    string | symbol

listeners(eventName)  =>

    Function []
# off(eventName, listener) – Alias for emitter.removeListener().

    # eventName

      string | symbol

    # listener(args)

      # args

        any []

      listener(args)  =>

        void

off(eventName, listener)  =>

# on(eventName, listener) – Adds the listener function to the end of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple times. 

server.on('connection', stream => {
  console.log('someone connected!')
})

Returns a reference to the EventEmitter, so that calls can be chained.

By default, event listeners are invoked in the order they are added. Theemitter.prependListener() method can be used as an alternative to add the event listener to the beginning of the listeners array.

const myEE = new EventEmitter()
myEE.on('foo', () => console.log('a'))
myEE.prependListener('foo', () => console.log('b'))
myEE.emit('foo')
// Prints:
//   b
//   a
# eventName – The name of the event.

    string | symbol

# listener(args)

    # args

      any []

    listener(args)  =>

      void

on(eventName, listener)  =>

# once(eventName, listener) – Adds a one-timelistener function for the event named eventName. The next time eventName is triggered, this listener is removed and then invoked. 

server.once('connection', stream => {
  console.log('Ah, we have our first user!')
})

Returns a reference to the EventEmitter, so that calls can be chained.

By default, event listeners are invoked in the order they are added. Theemitter.prependOnceListener() method can be used as an alternative to add the event listener to the beginning of the listeners array.

const myEE = new EventEmitter()
myEE.once('foo', () => console.log('a'))
myEE.prependOnceListener('foo', () => console.log('b'))
myEE.emit('foo')
// Prints:
//   b
//   a
# eventName – The name of the event.

    string | symbol

# listener(args)

    # args

      any []

    listener(args)  =>

      void

once(eventName, listener)  =>

# prependListener(eventName, listener) – Adds the listener function to the beginning of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple times. 

server.prependListener('connection', stream => {
  console.log('someone connected!')
})

Returns a reference to the EventEmitter, so that calls can be chained.

# eventName – The name of the event.

    string | symbol

# listener(args)

    # args

      any []

    listener(args)  =>

      void

prependListener(eventName, listener)  =>

# prependOnceListener(eventName, listener) – Adds a one-timelistener function for the event named eventName to the_beginning_ of the listeners array. The next time eventName is triggered, this listener is removed, and then invoked. 

server.prependOnceListener('connection', stream => {
  console.log('Ah, we have our first user!')
})

Returns a reference to the EventEmitter, so that calls can be chained.

# eventName – The name of the event.

    string | symbol

# listener(args)

    # args

      any []

    listener(args)  =>

      void

prependOnceListener(eventName, listener)  =>

# rawListeners(eventName) – Returns a copy of the array of listeners for the event named eventName, including any wrappers (such as those created by .once()). 

const emitter = new EventEmitter()
emitter.once('log', () => console.log('log once'))

// Returns a new Array with a function `onceWrapper` which has a property
// `listener` which contains the original listener bound above
const listeners = emitter.rawListeners('log')
const logFnWrapper = listeners[0]

// Logs "log once" to the console and does not unbind the `once` event
logFnWrapper.listener()

// Logs "log once" to the console and removes the listener
logFnWrapper()

emitter.on('log', () => console.log('log persistently'))
// Will return a new Array with a single function bound by `.on()` above
const newListeners = emitter.rawListeners('log')

// Logs "log persistently" twice
newListeners[0]()
emitter.emit('log')
# eventName

    string | symbol

rawListeners(eventName)  =>

    Function []
# removeAllListeners(event) – Removes all listeners, or those of the specified eventName.

    It is bad practice to remove listeners added elsewhere in the code, particularly when the EventEmitter instance was created by some other component or module (e.g. sockets or file streams).

    Returns a reference to the EventEmitter, so that calls can be chained.

    # event

      string | symbol

    removeAllListeners(event)  =>

# removeListener(eventName, listener) – Removes the specified listener from the listener array for the event namedeventName. 

const callback = stream => {
  console.log('someone connected!')
}
server.on('connection', callback)
// ...
server.removeListener('connection', callback)

removeListener() will remove, at most, one instance of a listener from the listener array. If any single listener has been added multiple times to the listener array for the specified eventName, then removeListener() must be called multiple times to remove each instance.

Once an event is emitted, all listeners attached to it at the time of emitting are called in order. This implies that anyremoveListener() or removeAllListeners() calls after emitting and_before_ the last listener finishes execution will not remove them fromemit() in progress. Subsequent events behave as expected.

const myEmitter = new MyEmitter()

const callbackA = () => {
  console.log('A')
  myEmitter.removeListener('event', callbackB)
}

const callbackB = () => {
  console.log('B')
}

myEmitter.on('event', callbackA)

myEmitter.on('event', callbackB)

// callbackA removes listener callbackB but it will still be called.
// Internal listener array at time of emit [callbackA, callbackB]
myEmitter.emit('event')
// Prints:
//   A
//   B

// callbackB is now removed.
// Internal listener array [callbackA]
myEmitter.emit('event')
// Prints:
//   A

Because listeners are managed using an internal array, calling this will change the position indices of any listener registered after the listener being removed. This will not impact the order in which listeners are called, but it means that any copies of the listener array as returned by the emitter.listeners() method will need to be recreated.

When a single function has been added as a handler multiple times for a single event (as in the example below), removeListener() will remove the most recently added instance. In the example the once('ping')listener is removed:

const ee = new EventEmitter()

function pong() {
  console.log('pong')
}

ee.on('ping', pong)
ee.once('ping', pong)
ee.removeListener('ping', pong)

ee.emit('ping')
ee.emit('ping')

Returns a reference to the EventEmitter, so that calls can be chained.

# eventName

    string | symbol

# listener(args)

    # args

      any []

    listener(args)  =>

      void

removeListener(eventName, listener)  =>

# setMaxListeners(n) – By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default that helps finding memory leaks. The emitter.setMaxListeners() method allows the limit to be modified for this specific EventEmitter instance. The value can be set toInfinity (or 0) to indicate an unlimited number of listeners.

    Returns a reference to the EventEmitter, so that calls can be chained.

    # n

      number

    setMaxListeners(n)  =>

# getEventListeners(emitter, name) – Returns a copy of the array of listeners for the event named eventName. src/.fastpm/-/@types/node@17.0.45/events.d.ts#L270

    For EventEmitters this behaves exactly the same as calling .listeners on the emitter.

    For EventTargets this is the only way to get the event listeners for the event target. This is useful for debugging and diagnostic purposes.

const { getEventListeners, EventEmitter } = require('events')

{
  const ee = new EventEmitter()
  const listener = () => console.log('Events are fun')
  ee.on('foo', listener)
  getEventListeners(ee, 'foo') // [listener]
}
{
  const et = new EventTarget()
  const listener = () => console.log('Events are fun')
  et.addEventListener('foo', listener)
  getEventListeners(et, 'foo') // [listener]
}
# emitter
# name

    string | symbol

getEventListeners(emitter, name)  =>

    Function []
# listenerCount(emitter, eventName) – A class method that returns the number of listeners for the given eventNameregistered on the given emitter. src/.fastpm/-/@types/node@17.0.45/events.d.ts#L242 

const { EventEmitter, listenerCount } = require('events')
const myEmitter = new EventEmitter()
myEmitter.on('event', () => {})
myEmitter.on('event', () => {})
console.log(listenerCount(myEmitter, 'event'))
// Prints: 2
# emitter – The emitter to query
# eventName – The event name

    string | symbol

listenerCount(emitter, eventName)  =>

    number
# on(emitter, eventName, options) – ```js const { on, EventEmitter } = require('events'); src/.fastpm/-/@types/node@17.0.45/events.d.ts#L221

    (async () => { const ee = new EventEmitter();

    // Emit later on process.nextTick(() => { ee.emit('foo', 'bar'); ee.emit('foo', 42); });

    for await (const event of on(ee, 'foo')) { // The execution of this inner block is synchronous and it // processes one event at a time (even with await). Do not use // if concurrent execution is required. console.log(event); // prints ['bar'] [42] } // Unreachable here })();

Returns an `AsyncIterator` that iterates `eventName` events. It will throw
if the `EventEmitter` emits `'error'`. It removes all listeners when
exiting the loop. The `value` returned by each iteration is an array
composed of the emitted event arguments.

An `AbortSignal` can be used to cancel waiting on events:

```js
const { on, EventEmitter } = require('events');
const ac = new AbortController();

(async () => {
  const ee = new EventEmitter();

  // Emit later on
  process.nextTick(() => {
    ee.emit('foo', 'bar');
    ee.emit('foo', 42);
  });

  for await (const event of on(ee, 'foo', { signal: ac.signal })) {
    // The execution of this inner block is synchronous and it
    // processes one event at a time (even with await). Do not use
    // if concurrent execution is required.
    console.log(event); // prints ['bar'] [42]
  }
  // Unreachable here
})();

process.nextTick(() => ac.abort());
# emitter
# eventName – The name of the event being listened for

    string

# options

on(emitter, eventName, options)  =>

    AsyncIterableIterator<any>
# once(emitter, eventName, options) – Creates a Promise that is fulfilled when the EventEmitter emits the given event or that is rejected if the EventEmitter emits 'error' while waiting. The Promise will resolve with an array of all the arguments emitted to the given event. src/.fastpm/-/@types/node@17.0.45/events.d.ts#L157

    This method is intentionally generic and works with the web platform EventTarget interface, which has no special'error' event semantics and does not listen to the 'error' event.

const { once, EventEmitter } = require('events')

async function run() {
  const ee = new EventEmitter()

  process.nextTick(() => {
    ee.emit('myevent', 42)
  })

  const [value] = await once(ee, 'myevent')
  console.log(value)

  const err = new Error('kaboom')
  process.nextTick(() => {
    ee.emit('error', err)
  })

  try {
    await once(ee, 'myevent')
  } catch (err) {
    console.log('error happened', err)
  }
}

run()

The special handling of the 'error' event is only used when events.once()is used to wait for another event. If events.once() is used to wait for the 'error' event itself, then it is treated as any other kind of event without special handling:

const { EventEmitter, once } = require('events')

const ee = new EventEmitter()

once(ee, 'error')
  .then(([err]) => console.log('ok', err.message))
  .catch(err => console.log('error', err.message))

ee.emit('error', new Error('boom'))

// Prints: ok boom

An AbortSignal can be used to cancel waiting for the event:

const { EventEmitter, once } = require('events')

const ee = new EventEmitter()
const ac = new AbortController()

async function foo(emitter, event, signal) {
  try {
    await once(emitter, event, { signal })
    console.log('event emitted!')
  } catch (error) {
    if (error.name === 'AbortError') {
      console.error('Waiting for the event was canceled!')
    } else {
      console.error('There was an error', error.message)
    }
  }
}

foo(ee, 'foo', ac.signal)
ac.abort() // Abort waiting for the event
ee.emit('foo') // Prints: Waiting for the event was canceled!
# emitter
# eventName

    string | symbol

# options

once(emitter, eventName, options)  =>

    Promise<any []>
# emitter
# eventName

    string

# options

once(emitter, eventName, options)  =>

    Promise<any []>
# setMaxListeners(n, eventTargets) – By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default that helps finding memory leaks. The EventEmitter.setMaxListeners() method allows the default limit to be modified (if eventTargets is empty) or modify the limit specified in every EventTarget | EventEmitter passed as arguments. The value can be set toInfinity (or 0) to indicate an unlimited number of listeners. src/.fastpm/-/@types/node@17.0.45/events.d.ts#L290 

EventEmitter.setMaxListeners(20)
// Equivalent to
EventEmitter.defaultMaxListeners = 20

const eventTarget = new EventTarget()
// Only way to increase limit for `EventTarget` instances
// as these doesn't expose its own `setMaxListeners` method
EventEmitter.setMaxListeners(20, eventTarget)
# n

    number

# eventTargets

setMaxListeners(n, eventTargets)  =>

    void
# Abortable src/.fastpm/-/@types/node@17.0.45/events.d.ts#L313
# WebSocket_2 src/.fastpm/-/vite@3.0.4/dist/node/index.d.ts#L2882
# clients src/.fastpm/-/vite@3.0.4/dist/node/index.d.ts#L3029

    Set<T>

# options src/.fastpm/-/vite@3.0.4/dist/node/index.d.ts#L3027
# path src/.fastpm/-/vite@3.0.4/dist/node/index.d.ts#L3028

    string

# captureRejectionSymbol src/.fastpm/-/@types/node@17.0.45/events.d.ts#L301
# captureRejections – Sets or gets the default captureRejection value for all emitters. src/.fastpm/-/@types/node@17.0.45/events.d.ts#L306

    boolean

# defaultMaxListeners src/.fastpm/-/@types/node@17.0.45/events.d.ts#L307

    number

# errorMonitor – This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called. src/.fastpm/-/@types/node@17.0.45/events.d.ts#L300

    typeof errorMonitor

    Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

# addListener(event, cb) – Alias for emitter.on(eventName, listener). src/.fastpm/-/vite@3.0.4/dist/node/index.d.ts#L3089

    # event

      "connection"

    # cb(client, request)

addListener(event, cb)  =>

# event

    "error"

# cb(err)

    # err

      Error

    cb(err)  =>

      void

addListener(event, cb)  =>

# event

    "headers"

# cb(headers, request)

addListener(event, cb)  =>

# event

    "close" | "listening"

# cb()

    cb()  =>

      void

addListener(event, cb)  =>

# event

    string | symbol

# listener(args)

    # args

      any []

    listener(args)  =>

      void

addListener(event, listener)  =>

# address() src/.fastpm/-/vite@3.0.4/dist/node/index.d.ts#L3033
# close(cb) src/.fastpm/-/vite@3.0.4/dist/node/index.d.ts#L3034

    # cb(err)

      # err

        Error

      cb(err)  =>

        void

close(cb)  =>

    void
# emit(eventName, args) – Synchronously calls each of the listeners registered for the event namedeventName, in the order they were registered, passing the supplied arguments to each.

    Returns true if the event had listeners, false otherwise.

const EventEmitter = require('events')
const myEmitter = new EventEmitter()

// First listener
myEmitter.on('event', function firstListener() {
  console.log('Helloooo! first listener')
})
// Second listener
myEmitter.on('event', function secondListener(arg1, arg2) {
  console.log(`event with parameters ${arg1}, ${arg2} in second listener`)
})
// Third listener
myEmitter.on('event', function thirdListener(...args) {
  const parameters = args.join(', ')
  console.log(`event with parameters ${parameters} in third listener`)
})

console.log(myEmitter.listeners('event'))

myEmitter.emit('event', 1, 2, 3, 4, 5)

// Prints:
// [
//   [Function: firstListener],
//   [Function: secondListener],
//   [Function: thirdListener]
// ]
// Helloooo! first listener
// event with parameters 1, 2 in second listener
// event with parameters 1, 2, 3, 4, 5 in third listener
# eventName

    string | symbol

# args

    any []

emit(eventName, args)  =>

    boolean
# eventNames() – Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or Symbols. 

const EventEmitter = require('events')
const myEE = new EventEmitter()
myEE.on('foo', () => {})
myEE.on('bar', () => {})

const sym = Symbol('symbol')
myEE.on(sym, () => {})

console.log(myEE.eventNames())
// Prints: [ 'foo', 'bar', Symbol(symbol) ]

eventNames()  =>

    string | symbol []
# getMaxListeners() – Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to {@link defaultMaxListeners}.

    getMaxListeners()  =>

      number
# handleUpgrade(request, socket, upgradeHead, callback) src/.fastpm/-/vite@3.0.4/dist/node/index.d.ts#L3035

handleUpgrade(request, socket, upgradeHead, callback)  =>

    void
# listenerCount(eventName) – Returns the number of listeners listening to the event named eventName.

    # eventName – The name of the event being listened for

      string | symbol

    listenerCount(eventName)  =>

      number
# listeners(eventName) – Returns a copy of the array of listeners for the event named eventName. 

server.on('connection', stream => {
  console.log('someone connected!')
})
console.log(util.inspect(server.listeners('connection')))
// Prints: [ [Function] ]
# eventName

    string | symbol

listeners(eventName)  =>

    Function []
# off(event, cb) – Alias for emitter.removeListener(). src/.fastpm/-/vite@3.0.4/dist/node/index.d.ts#L3074

    # event

      "connection"

    # cb(this, socket, request)

off(event, cb)  =>

# event

    "error"

# cb(this, error)

    # this
    # error

      Error

    cb(this, error)  =>

      void

off(event, cb)  =>

# event

    "headers"

# cb(this, headers, request)

off(event, cb)  =>

# event

    "close" | "listening"

# cb(this)

off(event, cb)  =>

# event

    string | symbol

# listener(this, args)

    # this
    # args

      any []

    listener(this, args)  =>

      void

off(event, listener)  =>

# on(event, cb) – Adds the listener function to the end of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple times. src/.fastpm/-/vite@3.0.4/dist/node/index.d.ts#L3044 

server.on('connection', stream => {
  console.log('someone connected!')
})

Returns a reference to the EventEmitter, so that calls can be chained.

By default, event listeners are invoked in the order they are added. Theemitter.prependListener() method can be used as an alternative to add the event listener to the beginning of the listeners array.

const myEE = new EventEmitter()
myEE.on('foo', () => console.log('a'))
myEE.prependListener('foo', () => console.log('b'))
myEE.emit('foo')
// Prints:
//   b
//   a
# event

    "connection"

# cb(this, socket, request)

on(event, cb)  =>

# event

    "error"

# cb(this, error)

    # this
    # error

      Error

    cb(this, error)  =>

      void

on(event, cb)  =>

# event

    "headers"

# cb(this, headers, request)

on(event, cb)  =>

# event

    "close" | "listening"

# cb(this)

on(event, cb)  =>

# event

    string | symbol

# listener(this, args)

    # this
    # args

      any []

    listener(this, args)  =>

      void

on(event, listener)  =>

# once(event, cb) – Adds a one-timelistener function for the event named eventName. The next time eventName is triggered, this listener is removed and then invoked. src/.fastpm/-/vite@3.0.4/dist/node/index.d.ts#L3059 

server.once('connection', stream => {
  console.log('Ah, we have our first user!')
})

Returns a reference to the EventEmitter, so that calls can be chained.

By default, event listeners are invoked in the order they are added. Theemitter.prependOnceListener() method can be used as an alternative to add the event listener to the beginning of the listeners array.

const myEE = new EventEmitter()
myEE.once('foo', () => console.log('a'))
myEE.prependOnceListener('foo', () => console.log('b'))
myEE.emit('foo')
// Prints:
//   b
//   a
# event

    "connection"

# cb(this, socket, request)

once(event, cb)  =>

# event

    "error"

# cb(this, error)

    # this
    # error

      Error

    cb(this, error)  =>

      void

once(event, cb)  =>

# event

    "headers"

# cb(this, headers, request)

once(event, cb)  =>

# event

    "close" | "listening"

# cb(this)

once(event, cb)  =>

# event

    string | symbol

# listener(this, args)

    # this
    # args

      any []

    listener(this, args)  =>

      void

once(event, listener)  =>

# prependListener(eventName, listener) – Adds the listener function to the beginning of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple times. 

server.prependListener('connection', stream => {
  console.log('someone connected!')
})

Returns a reference to the EventEmitter, so that calls can be chained.

# eventName – The name of the event.

    string | symbol

# listener(args)

    # args

      any []

    listener(args)  =>

      void

prependListener(eventName, listener)  =>

# prependOnceListener(eventName, listener) – Adds a one-timelistener function for the event named eventName to the_beginning_ of the listeners array. The next time eventName is triggered, this listener is removed, and then invoked. 

server.prependOnceListener('connection', stream => {
  console.log('Ah, we have our first user!')
})

Returns a reference to the EventEmitter, so that calls can be chained.

# eventName – The name of the event.

    string | symbol

# listener(args)

    # args

      any []

    listener(args)  =>

      void

prependOnceListener(eventName, listener)  =>

# rawListeners(eventName) – Returns a copy of the array of listeners for the event named eventName, including any wrappers (such as those created by .once()). 

const emitter = new EventEmitter()
emitter.once('log', () => console.log('log once'))

// Returns a new Array with a function `onceWrapper` which has a property
// `listener` which contains the original listener bound above
const listeners = emitter.rawListeners('log')
const logFnWrapper = listeners[0]

// Logs "log once" to the console and does not unbind the `once` event
logFnWrapper.listener()

// Logs "log once" to the console and removes the listener
logFnWrapper()

emitter.on('log', () => console.log('log persistently'))
// Will return a new Array with a single function bound by `.on()` above
const newListeners = emitter.rawListeners('log')

// Logs "log persistently" twice
newListeners[0]()
emitter.emit('log')
# eventName

    string | symbol

rawListeners(eventName)  =>

    Function []
# removeAllListeners(event) – Removes all listeners, or those of the specified eventName.

    It is bad practice to remove listeners added elsewhere in the code, particularly when the EventEmitter instance was created by some other component or module (e.g. sockets or file streams).

    Returns a reference to the EventEmitter, so that calls can be chained.

    # event

      string | symbol

    removeAllListeners(event)  =>

# removeListener(event, cb) – Removes the specified listener from the listener array for the event namedeventName. src/.fastpm/-/vite@3.0.4/dist/node/index.d.ts#L3104 

const callback = stream => {
  console.log('someone connected!')
}
server.on('connection', callback)
// ...
server.removeListener('connection', callback)

removeListener() will remove, at most, one instance of a listener from the listener array. If any single listener has been added multiple times to the listener array for the specified eventName, then removeListener() must be called multiple times to remove each instance.

Once an event is emitted, all listeners attached to it at the time of emitting are called in order. This implies that anyremoveListener() or removeAllListeners() calls after emitting and_before_ the last listener finishes execution will not remove them fromemit() in progress. Subsequent events behave as expected.

const myEmitter = new MyEmitter()

const callbackA = () => {
  console.log('A')
  myEmitter.removeListener('event', callbackB)
}

const callbackB = () => {
  console.log('B')
}

myEmitter.on('event', callbackA)

myEmitter.on('event', callbackB)

// callbackA removes listener callbackB but it will still be called.
// Internal listener array at time of emit [callbackA, callbackB]
myEmitter.emit('event')
// Prints:
//   A
//   B

// callbackB is now removed.
// Internal listener array [callbackA]
myEmitter.emit('event')
// Prints:
//   A

Because listeners are managed using an internal array, calling this will change the position indices of any listener registered after the listener being removed. This will not impact the order in which listeners are called, but it means that any copies of the listener array as returned by the emitter.listeners() method will need to be recreated.

When a single function has been added as a handler multiple times for a single event (as in the example below), removeListener() will remove the most recently added instance. In the example the once('ping')listener is removed:

const ee = new EventEmitter()

function pong() {
  console.log('pong')
}

ee.on('ping', pong)
ee.once('ping', pong)
ee.removeListener('ping', pong)

ee.emit('ping')
ee.emit('ping')

Returns a reference to the EventEmitter, so that calls can be chained.

# event

    "connection"

# cb(client)

    # client

    cb(client)  =>

      void

removeListener(event, cb)  =>

# event

    "error"

# cb(err)

    # err

      Error

    cb(err)  =>

      void

removeListener(event, cb)  =>

# event

    "headers"

# cb(headers, request)

removeListener(event, cb)  =>

# event

    "close" | "listening"

# cb()

    cb()  =>

      void

removeListener(event, cb)  =>

# event

    string | symbol

# listener(args)

    # args

      any []

    listener(args)  =>

      void

removeListener(event, listener)  =>

# setMaxListeners(n) – By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default that helps finding memory leaks. The emitter.setMaxListeners() method allows the limit to be modified for this specific EventEmitter instance. The value can be set toInfinity (or 0) to indicate an unlimited number of listeners.

    Returns a reference to the EventEmitter, so that calls can be chained.

    # n

      number

    setMaxListeners(n)  =>

# shouldHandle(request) src/.fastpm/-/vite@3.0.4/dist/node/index.d.ts#L3041

    # request

    shouldHandle(request)  =>

      boolean | Promise<boolean>
# getEventListeners(emitter, name) – Returns a copy of the array of listeners for the event named eventName. src/.fastpm/-/@types/node@17.0.45/events.d.ts#L270

    For EventEmitters this behaves exactly the same as calling .listeners on the emitter.

    For EventTargets this is the only way to get the event listeners for the event target. This is useful for debugging and diagnostic purposes.

const { getEventListeners, EventEmitter } = require('events')

{
  const ee = new EventEmitter()
  const listener = () => console.log('Events are fun')
  ee.on('foo', listener)
  getEventListeners(ee, 'foo') // [listener]
}
{
  const et = new EventTarget()
  const listener = () => console.log('Events are fun')
  et.addEventListener('foo', listener)
  getEventListeners(et, 'foo') // [listener]
}
# emitter
# name

    string | symbol

getEventListeners(emitter, name)  =>

    Function []
# listenerCount(emitter, eventName) – A class method that returns the number of listeners for the given eventNameregistered on the given emitter. src/.fastpm/-/@types/node@17.0.45/events.d.ts#L242 

const { EventEmitter, listenerCount } = require('events')
const myEmitter = new EventEmitter()
myEmitter.on('event', () => {})
myEmitter.on('event', () => {})
console.log(listenerCount(myEmitter, 'event'))
// Prints: 2
# emitter – The emitter to query
# eventName – The event name

    string | symbol

listenerCount(emitter, eventName)  =>

    number
# on(emitter, eventName, options) – ```js const { on, EventEmitter } = require('events'); src/.fastpm/-/@types/node@17.0.45/events.d.ts#L221

    (async () => { const ee = new EventEmitter();

    // Emit later on process.nextTick(() => { ee.emit('foo', 'bar'); ee.emit('foo', 42); });

    for await (const event of on(ee, 'foo')) { // The execution of this inner block is synchronous and it // processes one event at a time (even with await). Do not use // if concurrent execution is required. console.log(event); // prints ['bar'] [42] } // Unreachable here })();

Returns an `AsyncIterator` that iterates `eventName` events. It will throw
if the `EventEmitter` emits `'error'`. It removes all listeners when
exiting the loop. The `value` returned by each iteration is an array
composed of the emitted event arguments.

An `AbortSignal` can be used to cancel waiting on events:

```js
const { on, EventEmitter } = require('events');
const ac = new AbortController();

(async () => {
  const ee = new EventEmitter();

  // Emit later on
  process.nextTick(() => {
    ee.emit('foo', 'bar');
    ee.emit('foo', 42);
  });

  for await (const event of on(ee, 'foo', { signal: ac.signal })) {
    // The execution of this inner block is synchronous and it
    // processes one event at a time (even with await). Do not use
    // if concurrent execution is required.
    console.log(event); // prints ['bar'] [42]
  }
  // Unreachable here
})();

process.nextTick(() => ac.abort());
# emitter
# eventName – The name of the event being listened for

    string

# options

on(emitter, eventName, options)  =>

    AsyncIterableIterator<any>
# once(emitter, eventName, options) – Creates a Promise that is fulfilled when the EventEmitter emits the given event or that is rejected if the EventEmitter emits 'error' while waiting. The Promise will resolve with an array of all the arguments emitted to the given event. src/.fastpm/-/@types/node@17.0.45/events.d.ts#L157

    This method is intentionally generic and works with the web platform EventTarget interface, which has no special'error' event semantics and does not listen to the 'error' event.

const { once, EventEmitter } = require('events')

async function run() {
  const ee = new EventEmitter()

  process.nextTick(() => {
    ee.emit('myevent', 42)
  })

  const [value] = await once(ee, 'myevent')
  console.log(value)

  const err = new Error('kaboom')
  process.nextTick(() => {
    ee.emit('error', err)
  })

  try {
    await once(ee, 'myevent')
  } catch (err) {
    console.log('error happened', err)
  }
}

run()

The special handling of the 'error' event is only used when events.once()is used to wait for another event. If events.once() is used to wait for the 'error' event itself, then it is treated as any other kind of event without special handling:

const { EventEmitter, once } = require('events')

const ee = new EventEmitter()

once(ee, 'error')
  .then(([err]) => console.log('ok', err.message))
  .catch(err => console.log('error', err.message))

ee.emit('error', new Error('boom'))

// Prints: ok boom

An AbortSignal can be used to cancel waiting for the event:

const { EventEmitter, once } = require('events')

const ee = new EventEmitter()
const ac = new AbortController()

async function foo(emitter, event, signal) {
  try {
    await once(emitter, event, { signal })
    console.log('event emitted!')
  } catch (error) {
    if (error.name === 'AbortError') {
      console.error('Waiting for the event was canceled!')
    } else {
      console.error('There was an error', error.message)
    }
  }
}

foo(ee, 'foo', ac.signal)
ac.abort() // Abort waiting for the event
ee.emit('foo') // Prints: Waiting for the event was canceled!
# emitter
# eventName

    string | symbol

# options

once(emitter, eventName, options)  =>

    Promise<any []>
# emitter
# eventName

    string

# options

once(emitter, eventName, options)  =>

    Promise<any []>
# setMaxListeners(n, eventTargets) – By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default that helps finding memory leaks. The EventEmitter.setMaxListeners() method allows the default limit to be modified (if eventTargets is empty) or modify the limit specified in every EventTarget | EventEmitter passed as arguments. The value can be set toInfinity (or 0) to indicate an unlimited number of listeners. src/.fastpm/-/@types/node@17.0.45/events.d.ts#L290 

EventEmitter.setMaxListeners(20)
// Equivalent to
EventEmitter.defaultMaxListeners = 20

const eventTarget = new EventTarget()
// Only way to increase limit for `EventTarget` instances
// as these doesn't expose its own `setMaxListeners` method
EventEmitter.setMaxListeners(20, eventTarget)
# n

    number

# eventTargets

setMaxListeners(n, eventTargets)  =>

    void
# AddressInfo src/.fastpm/-/vite@3.0.4/dist/node/index.d.ts#L3019
# ClientOptions src/.fastpm/-/vite@3.0.4/dist/node/index.d.ts#L2924
# generateMask(mask)

    # mask

    generateMask(mask)  =>

      void
# CloseEvent src/.fastpm/-/vite@3.0.4/dist/node/index.d.ts#L2979
# ErrorEvent src/.fastpm/-/vite@3.0.4/dist/node/index.d.ts#L2972
# Event src/.fastpm/-/vite@3.0.4/dist/node/index.d.ts#L2967
# EventListenerOptions src/.fastpm/-/vite@3.0.4/dist/node/index.d.ts#L2993
# MessageEvent src/.fastpm/-/vite@3.0.4/dist/node/index.d.ts#L2987
# PerMessageDeflateOptions src/.fastpm/-/vite@3.0.4/dist/node/index.d.ts#L2944
# zlibInflateOptions src/.fastpm/-/vite@3.0.4/dist/node/index.d.ts#L2962
# ServerOptions src/.fastpm/-/vite@3.0.4/dist/node/index.d.ts#L2997
# WebSocket src/.fastpm/-/vite@3.0.4/dist/node/index.d.ts#L3120
# onerror src/.fastpm/-/vite@3.0.4/dist/node/index.d.ts#L2648
# onmessage src/.fastpm/-/vite@3.0.4/dist/node/index.d.ts#L2650
# onopen src/.fastpm/-/vite@3.0.4/dist/node/index.d.ts#L2647

    null |

    # (event)

      # event

      (event)  =>

        void

# protocol src/.fastpm/-/vite@3.0.4/dist/node/index.d.ts#L2629

    string

# readyState – The current state of the connection src/.fastpm/-/vite@3.0.4/dist/node/index.d.ts#L2631

    0 | 1 | 2 | 3

# url src/.fastpm/-/vite@3.0.4/dist/node/index.d.ts#L2636

    string

# addEventListener(method, cb, options) src/.fastpm/-/vite@3.0.4/dist/node/index.d.ts#L2692
# options

addEventListener(method, cb, options)  =>

    void
# method

    "close"

# cb(event)
# options

addEventListener(method, cb, options)  =>

    void
# method

    "error"

# cb(event)
# options

addEventListener(method, cb, options)  =>

    void
# method

    "open"

# cb(event)

    # event

    cb(event)  =>

      void
# options

addEventListener(method, cb, options)  =>

    void
# addListener(event, listener) src/.fastpm/-/vite@3.0.4/dist/node/index.d.ts#L2836

    # event

      "close"

    # listener(code, reason)

      # code

        number

      # reason

      listener(code, reason)  =>

        void

addListener(event, listener)  =>

# event

    "error"

# listener(err)

    # err

      Error

    listener(err)  =>

      void

addListener(event, listener)  =>

# event

    "upgrade"

# listener(request)

addListener(event, listener)  =>

# event

    "message"

# listener(data, isBinary)

    # data
    # isBinary

      boolean

    listener(data, isBinary)  =>

      void

addListener(event, listener)  =>

# event

    "open"

# listener()

    listener()  =>

      void

addListener(event, listener)  =>

# event

    "ping" | "pong"

# listener(data)

    # data

    listener(data)  =>

      void

addListener(event, listener)  =>

# event

    "unexpected-response"

# listener(request, response)

addListener(event, listener)  =>

# event

    string | symbol

# listener(args)

    # args

      any []

    listener(args)  =>

      void

addListener(event, listener)  =>

# close(code, data) src/.fastpm/-/vite@3.0.4/dist/node/index.d.ts#L2663

    # code

      number

    # data

    close(code, data)  =>

      void
# emit(eventName, args) – Synchronously calls each of the listeners registered for the event namedeventName, in the order they were registered, passing the supplied arguments to each.

    Returns true if the event had listeners, false otherwise.

const EventEmitter = require('events')
const myEmitter = new EventEmitter()

// First listener
myEmitter.on('event', function firstListener() {
  console.log('Helloooo! first listener')
})
// Second listener
myEmitter.on('event', function secondListener(arg1, arg2) {
  console.log(`event with parameters ${arg1}, ${arg2} in second listener`)
})
// Third listener
myEmitter.on('event', function thirdListener(...args) {
  const parameters = args.join(', ')
  console.log(`event with parameters ${parameters} in third listener`)
})

console.log(myEmitter.listeners('event'))

myEmitter.emit('event', 1, 2, 3, 4, 5)

// Prints:
// [
//   [Function: firstListener],
//   [Function: secondListener],
//   [Function: thirdListener]
// ]
// Helloooo! first listener
// event with parameters 1, 2 in second listener
// event with parameters 1, 2, 3, 4, 5 in third listener
# eventName

    string | symbol

# args

    any []

emit(eventName, args)  =>

    boolean
# eventNames() – Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or Symbols. 

const EventEmitter = require('events')
const myEE = new EventEmitter()
myEE.on('foo', () => {})
myEE.on('bar', () => {})

const sym = Symbol('symbol')
myEE.on(sym, () => {})

console.log(myEE.eventNames())
// Prints: [ 'foo', 'bar', Symbol(symbol) ]

eventNames()  =>

    string | symbol []
# getMaxListeners() – Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to {@link defaultMaxListeners}.

    getMaxListeners()  =>

      number
# listenerCount(eventName) – Returns the number of listeners listening to the event named eventName.

    # eventName – The name of the event being listened for

      string | symbol

    listenerCount(eventName)  =>

      number
# listeners(eventName) – Returns a copy of the array of listeners for the event named eventName. 

server.on('connection', stream => {
  console.log('someone connected!')
})
console.log(util.inspect(server.listeners('connection')))
// Prints: [ [Function] ]
# eventName

    string | symbol

listeners(eventName)  =>

    Function []
# off(event, listener) src/.fastpm/-/vite@3.0.4/dist/node/index.d.ts#L2801

    # event

      "close"

    # listener(this, code, reason)

off(event, listener)  =>

# event

    "error"

# listener(this, err)

off(event, listener)  =>

# event

    "upgrade"

# listener(this, request)

off(event, listener)  =>

# event

    "message"

# listener(this, data, isBinary)

off(event, listener)  =>

# event

    "open"

# listener(this)

off(event, listener)  =>

# event

    "ping" | "pong"

# listener(this, data)

off(event, listener)  =>

# event

    "unexpected-response"

# listener(this, request, response)

off(event, listener)  =>

# event

    string | symbol

# listener(this, args)

    # this
    # args

      any []

    listener(this, args)  =>

      void

off(event, listener)  =>

# on(event, listener) src/.fastpm/-/vite@3.0.4/dist/node/index.d.ts#L2731

    # event

      "close"

    # listener(this, code, reason)

on(event, listener)  =>

# event

    "error"

# listener(this, err)

on(event, listener)  =>

# event

    "upgrade"

# listener(this, request)

on(event, listener)  =>

# event

    "message"

# listener(this, data, isBinary)

on(event, listener)  =>

# event

    "open"

# listener(this)

on(event, listener)  =>

# event

    "ping" | "pong"

# listener(this, data)

on(event, listener)  =>

# event

    "unexpected-response"

# listener(this, request, response)

on(event, listener)  =>

# event

    string | symbol

# listener(this, args)

    # this
    # args

      any []

    listener(this, args)  =>

      void

on(event, listener)  =>

# once(event, listener) src/.fastpm/-/vite@3.0.4/dist/node/index.d.ts#L2766

    # event

      "close"

    # listener(this, code, reason)

once(event, listener)  =>

# event

    "error"

# listener(this, err)

once(event, listener)  =>

# event

    "upgrade"

# listener(this, request)

once(event, listener)  =>

# event

    "message"

# listener(this, data, isBinary)

once(event, listener)  =>

# event

    "open"

# listener(this)

once(event, listener)  =>

# event

    "ping" | "pong"

# listener(this, data)

once(event, listener)  =>

# event

    "unexpected-response"

# listener(this, request, response)

once(event, listener)  =>

# event

    string | symbol

# listener(this, args)

    # this
    # args

      any []

    listener(this, args)  =>

      void

once(event, listener)  =>

# pause() – Pause the websocket causing it to stop emitting events. Some events can still be emitted after this is called, until all buffered data is consumed. This method is a noop if the ready state is CONNECTING or CLOSED. src/.fastpm/-/vite@3.0.4/dist/node/index.d.ts#L2684

    pause()  =>

      void
# ping(data, mask, cb) src/.fastpm/-/vite@3.0.4/dist/node/index.d.ts#L2664

    # data

      any

    # mask

      boolean

    # cb(err)

      # err

        Error

      cb(err)  =>

        void

ping(data, mask, cb)  =>

    void
# pong(data, mask, cb) src/.fastpm/-/vite@3.0.4/dist/node/index.d.ts#L2665

    # data

      any

    # mask

      boolean

    # cb(err)

      # err

        Error

      cb(err)  =>

        void

pong(data, mask, cb)  =>

    void
# prependListener(eventName, listener) – Adds the listener function to the beginning of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple times. 

server.prependListener('connection', stream => {
  console.log('someone connected!')
})

Returns a reference to the EventEmitter, so that calls can be chained.

# eventName – The name of the event.

    string | symbol

# listener(args)

    # args

      any []

    listener(args)  =>

      void

prependListener(eventName, listener)  =>

# prependOnceListener(eventName, listener) – Adds a one-timelistener function for the event named eventName to the_beginning_ of the listeners array. The next time eventName is triggered, this listener is removed, and then invoked. 

server.prependOnceListener('connection', stream => {
  console.log('Ah, we have our first user!')
})

Returns a reference to the EventEmitter, so that calls can be chained.

# eventName – The name of the event.

    string | symbol

# listener(args)

    # args

      any []

    listener(args)  =>

      void

prependOnceListener(eventName, listener)  =>

# rawListeners(eventName) – Returns a copy of the array of listeners for the event named eventName, including any wrappers (such as those created by .once()). 

const emitter = new EventEmitter()
emitter.once('log', () => console.log('log once'))

// Returns a new Array with a function `onceWrapper` which has a property
// `listener` which contains the original listener bound above
const listeners = emitter.rawListeners('log')
const logFnWrapper = listeners[0]

// Logs "log once" to the console and does not unbind the `once` event
logFnWrapper.listener()

// Logs "log once" to the console and removes the listener
logFnWrapper()

emitter.on('log', () => console.log('log persistently'))
// Will return a new Array with a single function bound by `.on()` above
const newListeners = emitter.rawListeners('log')

// Logs "log persistently" twice
newListeners[0]()
emitter.emit('log')
# eventName

    string | symbol

rawListeners(eventName)  =>

    Function []
# removeAllListeners(event) – Removes all listeners, or those of the specified eventName.

    It is bad practice to remove listeners added elsewhere in the code, particularly when the EventEmitter instance was created by some other component or module (e.g. sockets or file streams).

    Returns a reference to the EventEmitter, so that calls can be chained.

    # event

      string | symbol

    removeAllListeners(event)  =>

# removeEventListener(method, cb) src/.fastpm/-/vite@3.0.4/dist/node/index.d.ts#L2713

removeEventListener(method, cb)  =>

    void
# method

    "close"

# cb(event)

removeEventListener(method, cb)  =>

    void
# method

    "error"

# cb(event)

removeEventListener(method, cb)  =>

    void
# method

    "open"

# cb(event)

    # event

    cb(event)  =>

      void

removeEventListener(method, cb)  =>

    void
# removeListener(event, listener) src/.fastpm/-/vite@3.0.4/dist/node/index.d.ts#L2857

    # event

      "close"

    # listener(code, reason)

      # code

        number

      # reason

      listener(code, reason)  =>

        void

removeListener(event, listener)  =>

# event

    "error"

# listener(err)

    # err

      Error

    listener(err)  =>

      void

removeListener(event, listener)  =>

# event

    "upgrade"

# listener(request)

removeListener(event, listener)  =>

# event

    "message"

# listener(data, isBinary)

    # data
    # isBinary

      boolean

    listener(data, isBinary)  =>

      void

removeListener(event, listener)  =>

# event

    "open"

# listener()

    listener()  =>

      void

removeListener(event, listener)  =>

# event

    "ping" | "pong"

# listener(data)

    # data

    listener(data)  =>

      void

removeListener(event, listener)  =>

# event

    "unexpected-response"

# listener(request, response)

removeListener(event, listener)  =>

# event

    string | symbol

# listener(args)

    # args

      any []

    listener(args)  =>

      void

removeListener(event, listener)  =>

# resume() – Make a paused socket resume emitting events. This method is a noop if the ready state is CONNECTING or CLOSED. src/.fastpm/-/vite@3.0.4/dist/node/index.d.ts#L2689

    resume()  =>

      void
# send(data, cb) src/.fastpm/-/vite@3.0.4/dist/node/index.d.ts#L2666

    # data

      any

    # cb(err)

      # err

        Error

      cb(err)  =>

        void

send(data, cb)  =>

    void
# data

    any

# options

Readme

Keywords

Package Sidebar

Install

npm i vite-open

Repository

github.com/stagas/vite-open

Homepage

github.com/stagas/vite-open#readme

Weekly Downloads

266

Version

3.1.0

License

MIT

Unpacked Size

5.13 MB

Total Files

19

Last publish

Collaborators

  • stagas
Try on RunKit
Report malware