These are the snippets the console’s Snippets dialog offers under Variables, storage and long runs. Each is TypeScript; in a .js script the console shows the same code with its types removed. Every one runs unchanged in Code Studio’s own tests. How the API they call behaves is in writing scripts and the script API reference.

Read script variables

Set script variables under Variables in the console. A secret variable reaches the script and is blanked out of every log line and result.

export default async function (event: unknown, context: ScriptContext) {
    const { SPACE_KEY, API_TOKEN } = context.environment.vars;
    if (!SPACE_KEY) throw new Error('Set the SPACE_KEY script variable.');
    log.info(`Working in ${SPACE_KEY}, token set: ${Boolean(API_TOKEN)}`);
    return { space: SPACE_KEY, mode: context.mode };
}

Remember something between runs

Keeps JSON between runs, here so each work item is handled once. A key with a time to live is deleted when it runs out.

export default async function (event: { issue?: { key: string } } | null) {
    const key = event?.issue?.key ?? 'DEMO-1';
    const seen = await store.get<boolean>(`welcomed:${key}`);
    if (seen) return { key, skipped: true };

    log.info(`First time for ${key}`);
    await store.set(`welcomed:${key}`, true, { ttlSeconds: 30 * 24 * 60 * 60 });
    return { key, skipped: false };
}

A long loop that resumes

Marks its place in a list with context.checkpoint. If the run continues in a new invocation, it starts from the last checkpoint.

interface State {
    next: number;
}

export default async function (event: unknown, context: ScriptContext<State>) {
    const keys = Array.from({ length: 500 }, (_, i) => `DEMO-${i + 1}`);
    let done = 0;
    for (let i = context.resumedFrom?.next ?? 0; i < keys.length; i++) {
        await jira.put(`/rest/api/3/issue/${keys[i]}`, { fields: { labels: ['migrated'] } }, { query: { notifyUsers: false } });
        done++;
        if (i % 25 === 24) context.checkpoint({ next: i + 1 });
    }
    return { done };
}

A problem or a question? Write to support@oktul.com or open a request in the Help Center (opens in a new tab).

Read script variables

Remember something between runs

A long loop that resumes

Related