Объявите и инициализируйте словарь в Typescript

249

Учитывая следующий код

interface IPerson {
   firstName: string;
   lastName: string;
}

var persons: { [id: string]: IPerson; } = {
   "p1": { firstName: "F1", lastName: "L1" },
   "p2": { firstName: "F2" }
};

Почему инициализация не отклонена? В конце концов, второй объект не имеет свойства lastName.

MGS
источник
11
Примечание: с тех пор это было исправлено (не уверен, какая именно версия TS). Я получаю эти ошибки в VS, как и следовало ожидать: Index signatures are incompatible. Type '{ firstName: string; }' is not assignable to type 'IPerson'. Property 'lastName' is missing in type '{ firstName: string; }'.
Simon_Weaver

Ответы:

290

Редактировать : с тех пор это было исправлено в последних версиях TS. Цитируя комментарий @ Simon_Weaver к посту ОП:

Примечание: с тех пор это было исправлено (не уверен, какая именно версия TS). Я получаю эти ошибки в VS, как и следовало ожидать:Index signatures are incompatible. Type '{ firstName: string; }' is not assignable to type 'IPerson'. Property 'lastName' is missing in type '{ firstName: string; }'.


Очевидно, это не работает при передаче начальных данных при объявлении. Я предполагаю, что это ошибка в TypeScript, поэтому вы должны исправить ее на сайте проекта.

Вы можете использовать типизированный словарь, разделив ваш пример в декларации и инициализации, например:

var persons: { [id: string] : IPerson; } = {};
persons["p1"] = { firstName: "F1", lastName: "L1" };
persons["p2"] = { firstName: "F2" }; // will result in an error
thomaux
источник
4
Зачем вам нужен idсимвол? Кажется, это не нужно.
Кевич
4
Используя idсимвол, вы можете объявить тип ключей словаря. С заявлением выше, вы не можете сделать следующее:persons[1] = { firstName: 'F1', lastName: 'L1' }
Thomaux
3
Всегда забывайте этот синтаксис по какой-то причине!
eddiewould
13
idсимвол можно назвать все , что вы , как и был разработан таким образом , чтобы сделать его более удобным для чтения кода. например { [username: string] : IPerson; }
Guy Park
1
@Robouste Я бы использовал метод findKey от Lodash или, если вы предпочитаете нативное решение, вы можете использовать Object.entries . Если вы заинтересованы в получении полного списка ключей, взгляните на Object.keys
thomaux
83

Для использования словарного объекта в машинописи вы можете использовать интерфейс, как показано ниже:

interface Dictionary<T> {
    [Key: string]: T;
}

и используйте это для своего типа свойства класса.

export class SearchParameters {
    SearchFor: Dictionary<string> = {};
}

использовать и инициализировать этот класс,

getUsers(): Observable<any> {
        var searchParams = new SearchParameters();
        searchParams.SearchFor['userId'] = '1';
        searchParams.SearchFor['userName'] = 'xyz';

        return this.http.post(searchParams, 'users/search')
            .map(res => {
                return res;
            })
            .catch(this.handleError.bind(this));
    }
Амол Бхор
источник
61

Я согласен с thomaux, что ошибка проверки типа инициализации является ошибкой TypeScript. Тем не менее, я все еще хотел найти способ объявить и инициализировать словарь в одном выражении с правильной проверкой типа. Эта реализация длиннее, однако она добавляет дополнительные функции, такие как containsKey(key: string)иremove(key: string) метод. Я подозреваю, что это можно упростить, когда дженерики станут доступны в версии 0.9.

Сначала мы объявляем базовый класс Dictionary и интерфейс. Интерфейс необходим для индексатора, потому что классы не могут его реализовать.

interface IDictionary {
    add(key: string, value: any): void;
    remove(key: string): void;
    containsKey(key: string): bool;
    keys(): string[];
    values(): any[];
}

class Dictionary {

    _keys: string[] = new string[];
    _values: any[] = new any[];

    constructor(init: { key: string; value: any; }[]) {

        for (var x = 0; x < init.length; x++) {
            this[init[x].key] = init[x].value;
            this._keys.push(init[x].key);
            this._values.push(init[x].value);
        }
    }

    add(key: string, value: any) {
        this[key] = value;
        this._keys.push(key);
        this._values.push(value);
    }

    remove(key: string) {
        var index = this._keys.indexOf(key, 0);
        this._keys.splice(index, 1);
        this._values.splice(index, 1);

        delete this[key];
    }

    keys(): string[] {
        return this._keys;
    }

    values(): any[] {
        return this._values;
    }

    containsKey(key: string) {
        if (typeof this[key] === "undefined") {
            return false;
        }

        return true;
    }

    toLookup(): IDictionary {
        return this;
    }
}

Теперь мы объявляем конкретный тип Person и интерфейс Dictionary / Dictionary. В PersonDictionary обратите внимание, как мы переопределяем values()и toLookup()возвращаем правильные типы.

interface IPerson {
    firstName: string;
    lastName: string;
}

interface IPersonDictionary extends IDictionary {
    [index: string]: IPerson;
    values(): IPerson[];
}

class PersonDictionary extends Dictionary {
    constructor(init: { key: string; value: IPerson; }[]) {
        super(init);
    }

    values(): IPerson[]{
        return this._values;
    }

    toLookup(): IPersonDictionary {
        return this;
    }
}

А вот простой пример инициализации и использования:

var persons = new PersonDictionary([
    { key: "p1", value: { firstName: "F1", lastName: "L2" } },
    { key: "p2", value: { firstName: "F2", lastName: "L2" } },
    { key: "p3", value: { firstName: "F3", lastName: "L3" } }
]).toLookup();


alert(persons["p1"].firstName + " " + persons["p1"].lastName);
// alert: F1 L2

persons.remove("p2");

if (!persons.containsKey("p2")) {
    alert("Key no longer exists");
    // alert: Key no longer exists
}

alert(persons.keys().join(", "));
// alert: p1, p3
dmck
источник
Очень полезный пример кода. «Интерфейс IDictionary» содержит небольшую опечатку, так как есть ссылка на IPerson.
Мгс
было бы неплохо также реализовать подсчет элементов
nurettin
@dmck Объявление containsKey(key: string): bool;не работает с TypeScript 1.5.0-beta . Это должно быть изменено на containsKey(key: string): boolean;.
Амарджит Сингх
1
почему вы не делите общий тип? Словарь <T>, то нет необходимости создавать класс PersonDictionary. Вы объявляете это так: var people = new Dictionary <IPerson> ();
Бенуа
1
Я использовал такой универсальный словарь эффективно. Я нашел это здесь: fabiolandoni.ch/…
CAK2
5

Вот более общая реализация словаря, вдохновленная этим из @dmck

    interface IDictionary<T> {
      add(key: string, value: T): void;
      remove(key: string): void;
      containsKey(key: string): boolean;
      keys(): string[];
      values(): T[];
    }

    class Dictionary<T> implements IDictionary<T> {

      _keys: string[] = [];
      _values: T[] = [];

      constructor(init?: { key: string; value: T; }[]) {
        if (init) {
          for (var x = 0; x < init.length; x++) {
            this[init[x].key] = init[x].value;
            this._keys.push(init[x].key);
            this._values.push(init[x].value);
          }
        }
      }

      add(key: string, value: T) {
        this[key] = value;
        this._keys.push(key);
        this._values.push(value);
      }

      remove(key: string) {
        var index = this._keys.indexOf(key, 0);
        this._keys.splice(index, 1);
        this._values.splice(index, 1);

        delete this[key];
      }

      keys(): string[] {
        return this._keys;
      }

      values(): T[] {
        return this._values;
      }

      containsKey(key: string) {
        if (typeof this[key] === "undefined") {
          return false;
        }

        return true;
      }

      toLookup(): IDictionary<T> {
        return this;
      }
    }
mbcom
источник
3

Если вы хотите игнорировать свойство, отметьте его как необязательное, добавив знак вопроса:

interface IPerson {
    firstName: string;
    lastName?: string;
}
Массимилиано Краус
источник
1
Суть вопроса в том, почему данный код скомпилирован без указания фамилии ...
Пьер Арло
-1

Теперь есть библиотека, которая предоставляет строго типизированные, запрашиваемые коллекции в машинописи.

Эти коллекции:

  • Список
  • Словарь

Библиотека называется ts-generic-collection-linq .

Исходный код на GitHub:

https://github.com/VeritasSoftware/ts-generic-collections

NPM:

https://www.npmjs.com/package/ts-generic-collections-linq

С помощью этой библиотеки вы можете создавать коллекции (например List<T>) и запрашивать их, как показано ниже.

    let owners = new List<Owner>();

    let owner = new Owner();
    owner.id = 1;
    owner.name = "John Doe";
    owners.add(owner);

    owner = new Owner();
    owner.id = 2;
    owner.name = "Jane Doe";
    owners.add(owner);    

    let pets = new List<Pet>();

    let pet = new Pet();
    pet.ownerId = 2;
    pet.name = "Sam";
    pet.sex = Sex.M;

    pets.add(pet);

    pet = new Pet();
    pet.ownerId = 1;
    pet.name = "Jenny";
    pet.sex = Sex.F;

    pets.add(pet);

    //query to get owners by the sex/gender of their pets
    let ownersByPetSex = owners.join(pets, owner => owner.id, pet => pet.ownerId, (x, y) => new OwnerPet(x,y))
                               .groupBy(x => [x.pet.sex])
                               .select(x =>  new OwnersByPetSex(x.groups[0], x.list.select(x => x.owner)));

    expect(ownersByPetSex.toArray().length === 2).toBeTruthy();

    expect(ownersByPetSex.toArray()[0].sex == Sex.F).toBeTruthy();
    expect(ownersByPetSex.toArray()[0].owners.length === 1).toBeTruthy();
    expect(ownersByPetSex.toArray()[0].owners.toArray()[0].name == "John Doe").toBeTruthy();

    expect(ownersByPetSex.toArray()[1].sex == Sex.M).toBeTruthy();
    expect(ownersByPetSex.toArray()[1].owners.length == 1).toBeTruthy();
    expect(ownersByPetSex.toArray()[1].owners.toArray()[0].name == "Jane Doe").toBeTruthy();
Джон
источник
не могу найти пакет npm для этого
Гарри
1
@Harry - пакет NPM называется "TS-родовая-коллекция-LINQ"
Ade