Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Support util.promisify.custom as a global symbol #31647

Closed
ExE-Boss opened this issue Feb 5, 2020 · 0 comments
Closed

Support util.promisify.custom as a global symbol #31647

ExE-Boss opened this issue Feb 5, 2020 · 0 comments

Comments

@ExE-Boss
Copy link
Contributor

ExE-Boss commented Feb 5, 2020 •
edited
Loading

Is your feature request related to a problem? Please describe.

Currently, util.promisify supports the util.promisify.custom symbol to provide a custom promisified version of the callback-taking function, this however doesn’t work cross‑realm and doesn’t work for packages that intend to support browsers.

There are currently several packages that provide util.promisify, but aren’t interoperable because of this (ex.: @nodejs’s built‑in util.promisify, @browserify’s util.promisify and @ljharb’s util.promisify)

Describe the solution you'd like

The best solution would be to expose this as a shared symbol using Symbol.for, like how #20821 (#20857) was done for util.inspect.custom.

The shared symbol would preferably be obtained using Symbol.for("nodejs.util.promisify.custom").

Describe alternatives you've considered

Keep the status quo and use a package like @mafintosh’s inspect‑custom‑symbol.
@ExE-Boss ExE-Boss mentioned this issue Feb 5, 2020
Open
ExE-Boss added a commit to ExE-Boss/node that referenced this issue Feb 7, 2020
@ExE-Boss
util: Use a global symbol for util.promisify.custom
5a96702 
Define `util.promisify.custom`
as `Symbol.for("nodejs.util.inspect.custom")`, rather than
as `Symbol("util.inspect.custom")`.

This allows custom `promisify` wrappers to easily/safely be defined
in non‑Node.js environments.

Fixes: nodejs#31647
@ExE-Boss ExE-Boss mentioned this issue Feb 7, 2020
Closed
4 tasks
ExE-Boss added a commit to ExE-Boss/util.promisify that referenced this issue Feb 8, 2020
@ExE-Boss
feat: use a global symbol for util.promisify.custom
45fac72 
Define `util.promisify.custom`
as `Symbol.for(nodejs.util.inspect.custom)`, rather than
as `Symbol(util.inspect.custom)`.

This allows custom `promisify` wrappers to easily/safely be defined
in non‑Node.js environments.

Refs: nodejs/node#31647
Refs: nodejs/node#31672
@ExE-Boss ExE-Boss mentioned this issue Feb 8, 2020
Merged
ExE-Boss added a commit to EB-Forks/node-util that referenced this issue Feb 8, 2020
@ExE-Boss
feat: use a global symbol for util.promisify.custom
ec9c70f 
Define `util.promisify.custom`
as `Symbol.for(nodejs.util.inspect.custom)`, rather than
as `Symbol(util.inspect.custom)`.

This allows custom `promisify` wrappers to easily/safely be defined
in non‑Node.js environments.

Refs: nodejs/node#31647
Refs: nodejs/node#31672
@ExE-Boss ExE-Boss mentioned this issue Feb 8, 2020
Open
ExE-Boss added a commit to ExE-Boss/util.promisify that referenced this issue Feb 8, 2020
@ExE-Boss
feat: use a global symbol for util.promisify.custom
e4a1d5b 
Define `util.promisify.custom`
as `Symbol.for("nodejs.util.inspect.custom")`, rather than
as `Symbol("util.inspect.custom")`.

This allows custom `promisify` wrappers to easily/safely be defined
in non‑Node.js environments.

Refs: nodejs/node#31647
Refs: nodejs/node#31672
ExE-Boss added a commit to EB-Forks/node-util that referenced this issue Feb 8, 2020
@ExE-Boss
feat: use a global symbol for util.promisify.custom
f89af7d 
Define `util.promisify.custom`
as `Symbol.for("nodejs.util.inspect.custom")`, rather than
as `Symbol("util.inspect.custom")`.

This allows custom `promisify` wrappers to easily/safely be defined
in non‑Node.js environments.

Refs: nodejs/node#31647
Refs: nodejs/node#31672
BridgeAR pushed a commit that referenced this issue Mar 17, 2020
@ExE-Boss @BridgeAR
util: use a global symbol for util.promisify.custom
975d6b0 
Define `util.promisify.custom`
as `Symbol.for("nodejs.util.inspect.custom")`, rather than
as `Symbol("util.inspect.custom")`.

This allows custom `promisify` wrappers to easily/safely be defined
in non‑Node.js environments.

Fixes: #31647

PR-URL: #31672
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Gus Caplan <me@gus.host>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
MylesBorins pushed a commit that referenced this issue Mar 24, 2020
@ExE-Boss @MylesBorins
util: use a global symbol for util.promisify.custom
53fd0d8 
Define `util.promisify.custom`
as `Symbol.for("nodejs.util.inspect.custom")`, rather than
as `Symbol("util.inspect.custom")`.

This allows custom `promisify` wrappers to easily/safely be defined
in non‑Node.js environments.

Fixes: #31647

PR-URL: #31672
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Gus Caplan <me@gus.host>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
MylesBorins pushed a commit to MylesBorins/node that referenced this issue Apr 1, 2020
@ExE-Boss @MylesBorins
util: use a global symbol for util.promisify.custom
673cd60 
Define `util.promisify.custom`
as `Symbol.for("nodejs.util.inspect.custom")`, rather than
as `Symbol("util.inspect.custom")`.

This allows custom `promisify` wrappers to easily/safely be defined
in non‑Node.js environments.

Fixes: nodejs#31647

PR-URL: nodejs#31672
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Gus Caplan <me@gus.host>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
ExE-Boss added a commit to ExE-Boss/node that referenced this issue Apr 1, 2020
@ExE-Boss
util: use a global symbol for util.promisify.custom
0a8c5c1 
Define `util.promisify.custom`
as `Symbol.for("nodejs.util.inspect.custom")`, rather than
as `Symbol("util.inspect.custom")`.

This allows custom `promisify` wrappers to easily/safely be defined
in non‑Node.js environments.

Fixes: nodejs#31647

PR-URL: nodejs#31672
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Gus Caplan <me@gus.host>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
MylesBorins pushed a commit that referenced this issue Apr 2, 2020
@ExE-Boss @MylesBorins
util: use a global symbol for util.promisify.custom
32c0449 
Define `util.promisify.custom`
as `Symbol.for("nodejs.util.inspect.custom")`, rather than
as `Symbol("util.inspect.custom")`.

This allows custom `promisify` wrappers to easily/safely be defined
in non‑Node.js environments.

Fixes: #31647

Backport-PR-URL: #32349
PR-URL: #31672
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Gus Caplan <me@gus.host>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
ExE-Boss added a commit to ExE-Boss/util.promisify that referenced this issue Jan 6, 2021
@ExE-Boss
feat: use a global symbol for util.promisify.custom
77319f0 
Define `util.promisify.custom`
as `Symbol.for("nodejs.util.inspect.custom")`, rather than
as `Symbol("util.inspect.custom")`.

This allows custom `promisify` wrappers to easily/safely be defined
in non‑Node.js environments.

Refs: nodejs/node#31647
Refs: nodejs/node#31672
ExE-Boss added a commit to ExE-Boss/util.promisify that referenced this issue Jan 6, 2021
@ExE-Boss
feat: use a global symbol for util.promisify.custom
2b9f90e 
Define `util.promisify.custom`
as `Symbol.for("nodejs.util.inspect.custom")`, rather than
as `Symbol("util.inspect.custom")`.

This allows custom `promisify` wrappers to easily/safely be defined
in non‑Node.js environments.

Refs: nodejs/node#31647
Refs: nodejs/node#31672
ljharb pushed a commit to ExE-Boss/util.promisify that referenced this issue Jan 6, 2021
@ExE-Boss @ljharb
[New] use a global symbol for util.promisify.custom
8f8631b 
Define `util.promisify.custom` as `Symbol.for("nodejs.util.inspect.custom")`, rather than as `Symbol("util.inspect.custom")`.

This allows custom `promisify` wrappers to easily/safely be defined in non‑Node.js environments.

Refs: nodejs/node#31647
Refs: nodejs/node#31672
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

util: use a global symbol for util.promisify.custom ExE-Boss/node
1 participant
@ExE-Boss