Можно ли обойтись без кастования типов при присваивании строки переменной с литеральным типом?

Question

[Алексей Николаев]

Доброго дня.
Есть тип, описывающий небольшой объект. По замыслу это должна быть константа.

declare type KDFEncryptOptions = {
  kdf: 'scrypt',
  n: 8192,
};

Однако, когда я тайпаю этим типом аргумент функции, я вижу сообщение "Type `string` is not assignable to type `scrypt`". Нашел решение, которое предполагает кастование типа при присваивании.
somefunction(encryptOptions as KDFEncryptOptions);
Но оно не подходит ввиду одной фундаментальной причины: в проекте ts используется только для design-time, только с описанием типов в декларационных файлах. Маразм? Да. Но как-то быть надо.

Как быть? Есть ли способы объявить строгий тип со строковым литератом, и при этом позволить строки (при условии, что они совпадут с литералом)? Или, может быть, можно настроить компилятор, чтобы он более лояльно относился к таким кейсам?

Заранее спасибо.

Answer 1

[Антон Швец]

попробуй так. мож прокатит

/**
 * @template {string} T
 * @param {T} encryptOptions
 */
function somefunction(encryptOptions)

это равнозначно в ts

function somefunction<T extends string>(encryptOptions: T)

правда если ты передаешь объект, нужно будет сделать отдельный тип с дженериком чисто для этой функции.

Comments

[Алексей Николаев]

Да, интересный вариант, спасибо. Сделал через другую нотацию при вызове, но попробую и ваш тоже)

await walletGen.createComplex(
  password, /** @type {KDFEncryptOptions} */ (ENCRYPT_OPTIONS)
);

правда если ты передаешь объект

Именно. Получается, мой способ проще)

[Антон Швец]

Алексей Николаев, а, ну это и есть каст в синтаксисе jsdoc-ts :)
А вопрос был "Можно ли обойтись без кастования типов"

Answer 2

[Алексей Николаев]

Нужно воспользоваться специальной директивой. Это равнозначно касту, но не является таковым на уровне программного кода.

await asyncFunction(
  /** @type {DesiredType} */ (argument)
);

Answer 3

[tosha4encko]

Так вам нужно, чтобы тип encryptOptions был KDFEncryptOptions -

declare interface KDFEncryptOptions {
  kdf: 'scrypt';
  n: 8192;
}

function somefunction(encryptOptions: KDFEncryptOptions) {
  console.log('!!!');
}

let a: KDFEncryptOptions = { kdf: 'scrypt', n: 8192 };

somefunction(a);

Comments

[Алексей Николаев]

Я же пишу, что нельзя использовать ts в коде. И let тоже плохой вариант, нужна константа.

[tosha4encko]

Алексей Николаев, тогда с предикатом можно попробовать. Что-то типа -

declare interface KDFEncryptOptions {
  kdf: 'scrypt';
  n: 8192;
}

function somefunction(encryptOptions: KDFEncryptOptions) {
  console.log('!!!');
}

let a = { kdf: 'scrypt', n: 8192 };

function isKDFEncryptOptions(obj: any): obj is KDFEncryptOptions {
  // какая-нибудь проверка
  return true;
}

if (isKDFEncryptOptions(a)) {
  somefunction(a);
}