Porting python's 'with' construct to TypeScript
$begingroup$
Now that async generators are available in the platforms I care about, I figured I'd try porting Python's ingenious with
construct to JS as a utility. My first stab looks like this:
type Index = string | symbol | number;
function isIndex(obj: any): obj is Index {
return (
typeof obj === 'string' ||
typeof obj === 'symbol' ||
typeof obj === 'number'
);
}
type Disposable<TDisposerKey extends Index> = {
[k in TDisposerKey]: DisposerMethod
};
type DisposerMethod = () => void | Promise<void>;
type DisposerCallback<TDisposable> = (res: TDisposable) => void | Promise<void>;
function using<
TDisposerKey extends Index,
TDisposable extends Disposable<TDisposerKey>
>(resource: TDisposable, key: TDisposerKey): AsyncIterable<TDisposable>;
function using<TDisposable>(
resource: TDisposable,
disposer: DisposerCallback<TDisposable>
): AsyncIterable<TDisposable>;
async function* using<
TDisposerKey extends Index,
TDisposable extends Disposable<TDisposerKey>
>(
resource: TDisposable,
keyOrDisposer: TDisposerKey | DisposerCallback<TDisposable>
): AsyncIterable<TDisposable> {
try {
yield resource;
} finally {
if (typeof keyOrDisposer === 'function') {
await keyOrDisposer(resource);
} else if (isIndex(keyOrDisposer)) {
await resource[keyOrDisposer]();
}
}
}
async function main(): Promise<any> {
for await (const db of using(new PouchDB('zz-data\foo'), 'close')) {
console.dir(await db.info());
return await db.get('qwertyuiop');
}
}
Does anything jump out at anybody? A for..await..of
loop with only one iteration is odd, but it's the only way to handle this lexically, and it saves me having to juggle types for a callback-based alternative which was fiddly to make generic. The overloads are also a mouthful, but that's TS for you.
async-await typescript
$endgroup$
add a comment |
$begingroup$
Now that async generators are available in the platforms I care about, I figured I'd try porting Python's ingenious with
construct to JS as a utility. My first stab looks like this:
type Index = string | symbol | number;
function isIndex(obj: any): obj is Index {
return (
typeof obj === 'string' ||
typeof obj === 'symbol' ||
typeof obj === 'number'
);
}
type Disposable<TDisposerKey extends Index> = {
[k in TDisposerKey]: DisposerMethod
};
type DisposerMethod = () => void | Promise<void>;
type DisposerCallback<TDisposable> = (res: TDisposable) => void | Promise<void>;
function using<
TDisposerKey extends Index,
TDisposable extends Disposable<TDisposerKey>
>(resource: TDisposable, key: TDisposerKey): AsyncIterable<TDisposable>;
function using<TDisposable>(
resource: TDisposable,
disposer: DisposerCallback<TDisposable>
): AsyncIterable<TDisposable>;
async function* using<
TDisposerKey extends Index,
TDisposable extends Disposable<TDisposerKey>
>(
resource: TDisposable,
keyOrDisposer: TDisposerKey | DisposerCallback<TDisposable>
): AsyncIterable<TDisposable> {
try {
yield resource;
} finally {
if (typeof keyOrDisposer === 'function') {
await keyOrDisposer(resource);
} else if (isIndex(keyOrDisposer)) {
await resource[keyOrDisposer]();
}
}
}
async function main(): Promise<any> {
for await (const db of using(new PouchDB('zz-data\foo'), 'close')) {
console.dir(await db.info());
return await db.get('qwertyuiop');
}
}
Does anything jump out at anybody? A for..await..of
loop with only one iteration is odd, but it's the only way to handle this lexically, and it saves me having to juggle types for a callback-based alternative which was fiddly to make generic. The overloads are also a mouthful, but that's TS for you.
async-await typescript
$endgroup$
add a comment |
$begingroup$
Now that async generators are available in the platforms I care about, I figured I'd try porting Python's ingenious with
construct to JS as a utility. My first stab looks like this:
type Index = string | symbol | number;
function isIndex(obj: any): obj is Index {
return (
typeof obj === 'string' ||
typeof obj === 'symbol' ||
typeof obj === 'number'
);
}
type Disposable<TDisposerKey extends Index> = {
[k in TDisposerKey]: DisposerMethod
};
type DisposerMethod = () => void | Promise<void>;
type DisposerCallback<TDisposable> = (res: TDisposable) => void | Promise<void>;
function using<
TDisposerKey extends Index,
TDisposable extends Disposable<TDisposerKey>
>(resource: TDisposable, key: TDisposerKey): AsyncIterable<TDisposable>;
function using<TDisposable>(
resource: TDisposable,
disposer: DisposerCallback<TDisposable>
): AsyncIterable<TDisposable>;
async function* using<
TDisposerKey extends Index,
TDisposable extends Disposable<TDisposerKey>
>(
resource: TDisposable,
keyOrDisposer: TDisposerKey | DisposerCallback<TDisposable>
): AsyncIterable<TDisposable> {
try {
yield resource;
} finally {
if (typeof keyOrDisposer === 'function') {
await keyOrDisposer(resource);
} else if (isIndex(keyOrDisposer)) {
await resource[keyOrDisposer]();
}
}
}
async function main(): Promise<any> {
for await (const db of using(new PouchDB('zz-data\foo'), 'close')) {
console.dir(await db.info());
return await db.get('qwertyuiop');
}
}
Does anything jump out at anybody? A for..await..of
loop with only one iteration is odd, but it's the only way to handle this lexically, and it saves me having to juggle types for a callback-based alternative which was fiddly to make generic. The overloads are also a mouthful, but that's TS for you.
async-await typescript
$endgroup$
Now that async generators are available in the platforms I care about, I figured I'd try porting Python's ingenious with
construct to JS as a utility. My first stab looks like this:
type Index = string | symbol | number;
function isIndex(obj: any): obj is Index {
return (
typeof obj === 'string' ||
typeof obj === 'symbol' ||
typeof obj === 'number'
);
}
type Disposable<TDisposerKey extends Index> = {
[k in TDisposerKey]: DisposerMethod
};
type DisposerMethod = () => void | Promise<void>;
type DisposerCallback<TDisposable> = (res: TDisposable) => void | Promise<void>;
function using<
TDisposerKey extends Index,
TDisposable extends Disposable<TDisposerKey>
>(resource: TDisposable, key: TDisposerKey): AsyncIterable<TDisposable>;
function using<TDisposable>(
resource: TDisposable,
disposer: DisposerCallback<TDisposable>
): AsyncIterable<TDisposable>;
async function* using<
TDisposerKey extends Index,
TDisposable extends Disposable<TDisposerKey>
>(
resource: TDisposable,
keyOrDisposer: TDisposerKey | DisposerCallback<TDisposable>
): AsyncIterable<TDisposable> {
try {
yield resource;
} finally {
if (typeof keyOrDisposer === 'function') {
await keyOrDisposer(resource);
} else if (isIndex(keyOrDisposer)) {
await resource[keyOrDisposer]();
}
}
}
async function main(): Promise<any> {
for await (const db of using(new PouchDB('zz-data\foo'), 'close')) {
console.dir(await db.info());
return await db.get('qwertyuiop');
}
}
Does anything jump out at anybody? A for..await..of
loop with only one iteration is odd, but it's the only way to handle this lexically, and it saves me having to juggle types for a callback-based alternative which was fiddly to make generic. The overloads are also a mouthful, but that's TS for you.
async-await typescript
async-await typescript
edited 3 mins ago
200_success
129k15153415
129k15153415
asked 10 hours ago
millimoosemillimoose
29527
29527
add a comment |
add a comment |
0
active
oldest
votes
Your Answer
StackExchange.ifUsing("editor", function () {
return StackExchange.using("mathjaxEditing", function () {
StackExchange.MarkdownEditor.creationCallbacks.add(function (editor, postfix) {
StackExchange.mathjaxEditing.prepareWmdForMathJax(editor, postfix, [["\$", "\$"]]);
});
});
}, "mathjax-editing");
StackExchange.ifUsing("editor", function () {
StackExchange.using("externalEditor", function () {
StackExchange.using("snippets", function () {
StackExchange.snippets.init();
});
});
}, "code-snippets");
StackExchange.ready(function() {
var channelOptions = {
tags: "".split(" "),
id: "196"
};
initTagRenderer("".split(" "), "".split(" "), channelOptions);
StackExchange.using("externalEditor", function() {
// Have to fire editor after snippets, if snippets enabled
if (StackExchange.settings.snippets.snippetsEnabled) {
StackExchange.using("snippets", function() {
createEditor();
});
}
else {
createEditor();
}
});
function createEditor() {
StackExchange.prepareEditor({
heartbeatType: 'answer',
autoActivateHeartbeat: false,
convertImagesToLinks: false,
noModals: true,
showLowRepImageUploadWarning: true,
reputationToPostImages: null,
bindNavPrevention: true,
postfix: "",
imageUploader: {
brandingHtml: "Powered by u003ca class="icon-imgur-white" href="https://imgur.com/"u003eu003c/au003e",
contentPolicyHtml: "User contributions licensed under u003ca href="https://creativecommons.org/licenses/by-sa/3.0/"u003ecc by-sa 3.0 with attribution requiredu003c/au003e u003ca href="https://stackoverflow.com/legal/content-policy"u003e(content policy)u003c/au003e",
allowUrls: true
},
onDemand: true,
discardSelector: ".discard-answer"
,immediatelyShowMarkdownHelp:true
});
}
});
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
StackExchange.ready(
function () {
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fcodereview.stackexchange.com%2fquestions%2f212636%2fporting-pythons-with-construct-to-typescript%23new-answer', 'question_page');
}
);
Post as a guest
Required, but never shown
0
active
oldest
votes
0
active
oldest
votes
active
oldest
votes
active
oldest
votes
Thanks for contributing an answer to Code Review Stack Exchange!
- Please be sure to answer the question. Provide details and share your research!
But avoid …
- Asking for help, clarification, or responding to other answers.
- Making statements based on opinion; back them up with references or personal experience.
Use MathJax to format equations. MathJax reference.
To learn more, see our tips on writing great answers.
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
StackExchange.ready(
function () {
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fcodereview.stackexchange.com%2fquestions%2f212636%2fporting-pythons-with-construct-to-typescript%23new-answer', 'question_page');
}
);
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown