@girs/geocodeglib-1.0 1.0.0-3.2.5 → 1.0.0-3.2.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -5,7 +5,7 @@
5
5
  ![downloads/week](https://img.shields.io/npm/dw/@girs/geocodeglib-1.0)
6
6
 
7
7
 
8
- GJS TypeScript type definitions for GeocodeGlib-1.0, generated from library version 1.0.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v3.2.5.
8
+ GJS TypeScript type definitions for GeocodeGlib-1.0, generated from library version 1.0.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v3.2.7.
9
9
 
10
10
  Geocode Helper library
11
11
 
@@ -685,6 +685,16 @@ export module Forward {
685
685
  * this area is returned.
686
686
  */
687
687
  search_area?: BoundingBox | null
688
+ /**
689
+ * The number of requested results to a search query.
690
+ */
691
+ answerCount?: number | null
692
+ /**
693
+ * The bounding box that limits the search area.
694
+ * If #GeocodeForward:bounded property is set to #TRUE only results from
695
+ * this area is returned.
696
+ */
697
+ searchArea?: BoundingBox | null
688
698
  }
689
699
 
690
700
  }
@@ -697,6 +707,10 @@ export interface Forward {
697
707
  * The number of requested results to a search query.
698
708
  */
699
709
  answer_count: number
710
+ /**
711
+ * The number of requested results to a search query.
712
+ */
713
+ answerCount: number
700
714
  /**
701
715
  * If set to #TRUE then only results in the #GeocodeForward:search-area
702
716
  * bounding box are returned.
@@ -710,6 +724,12 @@ export interface Forward {
710
724
  * this area is returned.
711
725
  */
712
726
  search_area: BoundingBox
727
+ /**
728
+ * The bounding box that limits the search area.
729
+ * If #GeocodeForward:bounded property is set to #TRUE only results from
730
+ * this area is returned.
731
+ */
732
+ searchArea: BoundingBox
713
733
 
714
734
  // Owm methods of GeocodeGlib-1.0.GeocodeGlib.Forward
715
735
 
@@ -843,7 +863,7 @@ export class Forward extends GObject.Object {
843
863
  * @param str a string containing a free-form description of the location
844
864
  * @returns a new #GeocodeForward. Use g_object_unref() when done.
845
865
  */
846
- static new_for_string(str: string | null): Forward
866
+ static new_for_string(str: string): Forward
847
867
  _init(config?: Forward.ConstructorProperties): void
848
868
  }
849
869
 
@@ -968,7 +988,7 @@ export interface Location {
968
988
  * Gets the description of location `loc`.
969
989
  * @returns The description of location @loc.
970
990
  */
971
- get_description(): string | null
991
+ get_description(): string
972
992
  /**
973
993
  * Calculates the distance in km, along the curvature of the Earth,
974
994
  * between 2 locations. Note that altitude changes are not
@@ -997,7 +1017,7 @@ export interface Location {
997
1017
  * Sets the description of `loc` to `description`.
998
1018
  * @param description a description for the location
999
1019
  */
1000
- set_description(description: string | null): void
1020
+ set_description(description: string): void
1001
1021
  /**
1002
1022
  * Initialize a #GeocodeLocation object with the given `uri`.
1003
1023
  *
@@ -1014,7 +1034,7 @@ export interface Location {
1014
1034
  * @param uri a URI mapping out a location
1015
1035
  * @returns %TRUE on success and %FALSE on error.
1016
1036
  */
1017
- set_from_uri(uri: string | null): boolean
1037
+ set_from_uri(uri: string): boolean
1018
1038
  /**
1019
1039
  * Creates a URI representing `loc` in the scheme specified in `scheme`.
1020
1040
  * @param scheme the scheme of the requested URI
@@ -1092,7 +1112,7 @@ export class Location extends GObject.Object {
1092
1112
  * @param description a description for the location
1093
1113
  * @returns a new #GeocodeLocation object. Use g_object_unref() when done.
1094
1114
  */
1095
- static new_with_description(latitude: number, longitude: number, accuracy: number, description: string | null): Location
1115
+ static new_with_description(latitude: number, longitude: number, accuracy: number, description: string): Location
1096
1116
  _init(config?: Location.ConstructorProperties): void
1097
1117
  }
1098
1118
 
@@ -1239,6 +1259,31 @@ export module Nominatim {
1239
1259
  * string.
1240
1260
  */
1241
1261
  user_agent?: string | null
1262
+ /**
1263
+ * The base URL of the Nominatim service, for example
1264
+ * `https://nominatim.example.org`.
1265
+ */
1266
+ baseUrl?: string | null
1267
+ /**
1268
+ * E-mail address of the maintainer of the software making the
1269
+ * geocoding requests to the Nominatim server. This is used to contact
1270
+ * them in the event of a problem with their usage. See
1271
+ * [the Nominatim API](http://wiki.openstreetmap.org/wiki/Nominatim).
1272
+ */
1273
+ maintainerEmailAddress?: string | null
1274
+ /**
1275
+ * User-Agent string to send with HTTP(S) requests, or %NULL to use the
1276
+ * default user agent, which is derived from the geocode-glib version
1277
+ * and #GApplication:id, for example: `geocode-glib/3.20 (MyAppId)`.
1278
+ *
1279
+ * As per the
1280
+ * [Nominatim usage policy](http://wiki.openstreetmap.org/wiki/Nominatim_usage_policy),
1281
+ * it should be set to a string which identifies the application which
1282
+ * is using geocode-glib, and must be a valid
1283
+ * [user agent](https://tools.ietf.org/html/rfc7231#section-5.5.3)
1284
+ * string.
1285
+ */
1286
+ userAgent?: string | null
1242
1287
  }
1243
1288
 
1244
1289
  }
@@ -1252,6 +1297,11 @@ export interface Nominatim extends Backend {
1252
1297
  * `https://nominatim.example.org`.
1253
1298
  */
1254
1299
  readonly base_url: string | null
1300
+ /**
1301
+ * The base URL of the Nominatim service, for example
1302
+ * `https://nominatim.example.org`.
1303
+ */
1304
+ readonly baseUrl: string | null
1255
1305
  /**
1256
1306
  * E-mail address of the maintainer of the software making the
1257
1307
  * geocoding requests to the Nominatim server. This is used to contact
@@ -1259,6 +1309,13 @@ export interface Nominatim extends Backend {
1259
1309
  * [the Nominatim API](http://wiki.openstreetmap.org/wiki/Nominatim).
1260
1310
  */
1261
1311
  readonly maintainer_email_address: string | null
1312
+ /**
1313
+ * E-mail address of the maintainer of the software making the
1314
+ * geocoding requests to the Nominatim server. This is used to contact
1315
+ * them in the event of a problem with their usage. See
1316
+ * [the Nominatim API](http://wiki.openstreetmap.org/wiki/Nominatim).
1317
+ */
1318
+ readonly maintainerEmailAddress: string | null
1262
1319
  /**
1263
1320
  * User-Agent string to send with HTTP(S) requests, or %NULL to use the
1264
1321
  * default user agent, which is derived from the geocode-glib version
@@ -1272,6 +1329,19 @@ export interface Nominatim extends Backend {
1272
1329
  * string.
1273
1330
  */
1274
1331
  user_agent: string | null
1332
+ /**
1333
+ * User-Agent string to send with HTTP(S) requests, or %NULL to use the
1334
+ * default user agent, which is derived from the geocode-glib version
1335
+ * and #GApplication:id, for example: `geocode-glib/3.20 (MyAppId)`.
1336
+ *
1337
+ * As per the
1338
+ * [Nominatim usage policy](http://wiki.openstreetmap.org/wiki/Nominatim_usage_policy),
1339
+ * it should be set to a string which identifies the application which
1340
+ * is using geocode-glib, and must be a valid
1341
+ * [user agent](https://tools.ietf.org/html/rfc7231#section-5.5.3)
1342
+ * string.
1343
+ */
1344
+ userAgent: string | null
1275
1345
 
1276
1346
  // Own fields of GeocodeGlib-1.0.GeocodeGlib.Nominatim
1277
1347
 
@@ -1279,8 +1349,8 @@ export interface Nominatim extends Backend {
1279
1349
 
1280
1350
  // Own virtual methods of GeocodeGlib-1.0.GeocodeGlib.Nominatim
1281
1351
 
1282
- vfunc_query(uri: string | null, cancellable: Gio.Cancellable | null): string | null
1283
- vfunc_query_async(uri: string | null, cancellable: Gio.Cancellable | null, callback: Gio.AsyncReadyCallback<this> | null): void
1352
+ vfunc_query(uri: string, cancellable: Gio.Cancellable | null): string | null
1353
+ vfunc_query_async(uri: string, cancellable: Gio.Cancellable | null, callback: Gio.AsyncReadyCallback<this> | null): void
1284
1354
  vfunc_query_finish(res: Gio.AsyncResult): string | null
1285
1355
 
1286
1356
  // Class property signals of GeocodeGlib-1.0.GeocodeGlib.Nominatim
@@ -1324,7 +1394,7 @@ export class Nominatim extends GObject.Object {
1324
1394
  * @param maintainer_email_address the email address of the software maintainer.
1325
1395
  * @returns a new #GeocodeNominatim. Use g_object_unref() when done.
1326
1396
  */
1327
- constructor(base_url: string | null, maintainer_email_address: string | null)
1397
+ constructor(base_url: string, maintainer_email_address: string)
1328
1398
  /**
1329
1399
  * Creates a new backend implementation for an online Nominatim server. See
1330
1400
  * the documentation for #GeocodeNominatim:base-url and
@@ -1334,7 +1404,7 @@ export class Nominatim extends GObject.Object {
1334
1404
  * @param maintainer_email_address the email address of the software maintainer.
1335
1405
  * @returns a new #GeocodeNominatim. Use g_object_unref() when done.
1336
1406
  */
1337
- static new(base_url: string | null, maintainer_email_address: string | null): Nominatim
1407
+ static new(base_url: string, maintainer_email_address: string): Nominatim
1338
1408
  _init(config?: Nominatim.ConstructorProperties): void
1339
1409
  /**
1340
1410
  * Gets a reference to the default Nominatim server on nominatim.gnome.org.
@@ -1425,6 +1495,38 @@ export module Place {
1425
1495
  * The town.
1426
1496
  */
1427
1497
  town?: string | null
1498
+ /**
1499
+ * The local administrative area.
1500
+ */
1501
+ administrativeArea?: string | null
1502
+ /**
1503
+ * The bounding box for the place.
1504
+ */
1505
+ boundingBox?: BoundingBox | null
1506
+ /**
1507
+ * The country code.
1508
+ */
1509
+ countryCode?: string | null
1510
+ /**
1511
+ * The OpenStreetMap id of the place.
1512
+ */
1513
+ osmId?: string | null
1514
+ /**
1515
+ * The OpenStreetMap type of the place.
1516
+ */
1517
+ osmType?: PlaceOsmType | null
1518
+ /**
1519
+ * The type of the place.
1520
+ */
1521
+ placeType?: PlaceType | null
1522
+ /**
1523
+ * The postal code.
1524
+ */
1525
+ postalCode?: string | null
1526
+ /**
1527
+ * The street address.
1528
+ */
1529
+ streetAddress?: string | null
1428
1530
  }
1429
1531
 
1430
1532
  }
@@ -1437,6 +1539,10 @@ export interface Place {
1437
1539
  * The local administrative area.
1438
1540
  */
1439
1541
  administrative_area: string | null
1542
+ /**
1543
+ * The local administrative area.
1544
+ */
1545
+ administrativeArea: string | null
1440
1546
  /**
1441
1547
  * A named area such as a campus or neighborhood.
1442
1548
  */
@@ -1445,6 +1551,10 @@ export interface Place {
1445
1551
  * The bounding box for the place.
1446
1552
  */
1447
1553
  bounding_box: BoundingBox
1554
+ /**
1555
+ * The bounding box for the place.
1556
+ */
1557
+ boundingBox: BoundingBox
1448
1558
  /**
1449
1559
  * A specific building on a street or in an area.
1450
1560
  */
@@ -1461,6 +1571,10 @@ export interface Place {
1461
1571
  * The country code.
1462
1572
  */
1463
1573
  country_code: string | null
1574
+ /**
1575
+ * The country code.
1576
+ */
1577
+ countryCode: string | null
1464
1578
  /**
1465
1579
  * The county.
1466
1580
  */
@@ -1481,18 +1595,34 @@ export interface Place {
1481
1595
  * The OpenStreetMap id of the place.
1482
1596
  */
1483
1597
  osm_id: string | null
1598
+ /**
1599
+ * The OpenStreetMap id of the place.
1600
+ */
1601
+ osmId: string | null
1484
1602
  /**
1485
1603
  * The OpenStreetMap type of the place.
1486
1604
  */
1487
1605
  osm_type: PlaceOsmType
1606
+ /**
1607
+ * The OpenStreetMap type of the place.
1608
+ */
1609
+ osmType: PlaceOsmType
1488
1610
  /**
1489
1611
  * The type of the place.
1490
1612
  */
1491
1613
  readonly place_type: PlaceType
1614
+ /**
1615
+ * The type of the place.
1616
+ */
1617
+ readonly placeType: PlaceType
1492
1618
  /**
1493
1619
  * The postal code.
1494
1620
  */
1495
1621
  postal_code: string | null
1622
+ /**
1623
+ * The postal code.
1624
+ */
1625
+ postalCode: string | null
1496
1626
  /**
1497
1627
  * The state.
1498
1628
  */
@@ -1505,6 +1635,10 @@ export interface Place {
1505
1635
  * The street address.
1506
1636
  */
1507
1637
  street_address: string | null
1638
+ /**
1639
+ * The street address.
1640
+ */
1641
+ streetAddress: string | null
1508
1642
  /**
1509
1643
  * The town.
1510
1644
  */
@@ -1528,12 +1662,12 @@ export interface Place {
1528
1662
  * Gets the local administrative area of the `place`.
1529
1663
  * @returns The local administrative area of the @place.
1530
1664
  */
1531
- get_administrative_area(): string | null
1665
+ get_administrative_area(): string
1532
1666
  /**
1533
1667
  * Gets the area of the `place`.
1534
1668
  * @returns The area of the @place.
1535
1669
  */
1536
- get_area(): string | null
1670
+ get_area(): string
1537
1671
  /**
1538
1672
  * Gets the bounding box for the place `place`.
1539
1673
  * @returns A #GeocodeBoundingBox, or NULL if boundaries are unknown.
@@ -1543,27 +1677,27 @@ export interface Place {
1543
1677
  * Gets the building of the `place`.
1544
1678
  * @returns The building of the @place.
1545
1679
  */
1546
- get_building(): string | null
1680
+ get_building(): string
1547
1681
  /**
1548
1682
  * Gets the continent of the `place`.
1549
1683
  * @returns The continent of the @place.
1550
1684
  */
1551
- get_continent(): string | null
1685
+ get_continent(): string
1552
1686
  /**
1553
1687
  * Gets the country of the `place`.
1554
1688
  * @returns The country of the @place.
1555
1689
  */
1556
- get_country(): string | null
1690
+ get_country(): string
1557
1691
  /**
1558
1692
  * Gets the ISO-3166 country code of the `place`.
1559
1693
  * @returns The ISO-3166 country code of the @place, in upper case.
1560
1694
  */
1561
- get_country_code(): string | null
1695
+ get_country_code(): string
1562
1696
  /**
1563
1697
  * Gets the county of the `place`.
1564
1698
  * @returns The country of the @place.
1565
1699
  */
1566
- get_county(): string | null
1700
+ get_county(): string
1567
1701
  /**
1568
1702
  * Gets the #GIcon representing the `place`.
1569
1703
  * @returns The #GIcon representing the @place.
@@ -1578,12 +1712,12 @@ export interface Place {
1578
1712
  * Gets the name of the `place`.
1579
1713
  * @returns The name of the @place.
1580
1714
  */
1581
- get_name(): string | null
1715
+ get_name(): string
1582
1716
  /**
1583
1717
  * Gets the OpenStreetMap ID of the `place`.
1584
1718
  * @returns The osm ID of the @place.
1585
1719
  */
1586
- get_osm_id(): string | null
1720
+ get_osm_id(): string
1587
1721
  /**
1588
1722
  * Gets the OpenStreetMap type of the `place`.
1589
1723
  * @returns The osm type of the @place.
@@ -1598,37 +1732,37 @@ export interface Place {
1598
1732
  * Gets the postal code of the `place`.
1599
1733
  * @returns The postal code of the @place.
1600
1734
  */
1601
- get_postal_code(): string | null
1735
+ get_postal_code(): string
1602
1736
  /**
1603
1737
  * Gets the state of the `place`.
1604
1738
  * @returns The state of the @place.
1605
1739
  */
1606
- get_state(): string | null
1740
+ get_state(): string
1607
1741
  /**
1608
1742
  * Gets the street of the `place`.
1609
1743
  * @returns The street of the @place.
1610
1744
  */
1611
- get_street(): string | null
1745
+ get_street(): string
1612
1746
  /**
1613
1747
  * Gets the street address of the `place`.
1614
1748
  * @returns The street address of the @place.
1615
1749
  */
1616
- get_street_address(): string | null
1750
+ get_street_address(): string
1617
1751
  /**
1618
1752
  * Gets the town of the `place`.
1619
1753
  * @returns The town of the @place.
1620
1754
  */
1621
- get_town(): string | null
1755
+ get_town(): string
1622
1756
  /**
1623
1757
  * Sets the local administrative area of `place` to `admin_area`.
1624
1758
  * @param admin_area an administrative area for the place
1625
1759
  */
1626
- set_administrative_area(admin_area: string | null): void
1760
+ set_administrative_area(admin_area: string): void
1627
1761
  /**
1628
1762
  * Sets the area of `place` to `area`.
1629
1763
  * @param area a area
1630
1764
  */
1631
- set_area(area: string | null): void
1765
+ set_area(area: string): void
1632
1766
  /**
1633
1767
  * Sets the #GeocodeBoundingBox for the place `place`.
1634
1768
  * @param bbox A #GeocodeBoundingBox for the place
@@ -1638,27 +1772,27 @@ export interface Place {
1638
1772
  * Sets the building of `place` to `building`.
1639
1773
  * @param building a building
1640
1774
  */
1641
- set_building(building: string | null): void
1775
+ set_building(building: string): void
1642
1776
  /**
1643
1777
  * Sets the continent of `place` to `continent`.
1644
1778
  * @param continent a continent for the place
1645
1779
  */
1646
- set_continent(continent: string | null): void
1780
+ set_continent(continent: string): void
1647
1781
  /**
1648
1782
  * Sets the country of `place` to `country`.
1649
1783
  * @param country a country for the place
1650
1784
  */
1651
- set_country(country: string | null): void
1785
+ set_country(country: string): void
1652
1786
  /**
1653
1787
  * Sets the ISO country code of `place` to `country_code`.
1654
1788
  * @param country_code an ISO country code for the place
1655
1789
  */
1656
- set_country_code(country_code: string | null): void
1790
+ set_country_code(country_code: string): void
1657
1791
  /**
1658
1792
  * Sets the county of `place` to `county`.
1659
1793
  * @param county a county for the place
1660
1794
  */
1661
- set_county(county: string | null): void
1795
+ set_county(county: string): void
1662
1796
  /**
1663
1797
  * Sets the location of `place` to `location`.
1664
1798
  * @param location A location
@@ -1668,32 +1802,32 @@ export interface Place {
1668
1802
  * Sets the name of the `place` to `name`.
1669
1803
  * @param name the name of place
1670
1804
  */
1671
- set_name(name: string | null): void
1805
+ set_name(name: string): void
1672
1806
  /**
1673
1807
  * Sets the postal code of `place` to `postal_code`.
1674
1808
  * @param postal_code a postal code for the place
1675
1809
  */
1676
- set_postal_code(postal_code: string | null): void
1810
+ set_postal_code(postal_code: string): void
1677
1811
  /**
1678
1812
  * Sets the state of `place` to `state`.
1679
1813
  * @param state a state for the place
1680
1814
  */
1681
- set_state(state: string | null): void
1815
+ set_state(state: string): void
1682
1816
  /**
1683
1817
  * Sets the street of `place` to `street`.
1684
1818
  * @param street a street
1685
1819
  */
1686
- set_street(street: string | null): void
1820
+ set_street(street: string): void
1687
1821
  /**
1688
1822
  * Sets the street address of `place` to `street_address`.
1689
1823
  * @param street_address a street address for the place
1690
1824
  */
1691
- set_street_address(street_address: string | null): void
1825
+ set_street_address(street_address: string): void
1692
1826
  /**
1693
1827
  * Sets the town of `place` to `town`.
1694
1828
  * @param town a town for the place
1695
1829
  */
1696
- set_town(town: string | null): void
1830
+ set_town(town: string): void
1697
1831
 
1698
1832
  // Class property signals of GeocodeGlib-1.0.GeocodeGlib.Place
1699
1833
 
@@ -1781,7 +1915,7 @@ export class Place extends GObject.Object {
1781
1915
  * @param place_type the type of place
1782
1916
  * @returns a new #GeocodePlace object. Use g_object_unref() when done.
1783
1917
  */
1784
- constructor(name: string | null, place_type: PlaceType)
1918
+ constructor(name: string, place_type: PlaceType)
1785
1919
  /**
1786
1920
  * Creates a new #GeocodePlace object.
1787
1921
  * @constructor
@@ -1789,7 +1923,7 @@ export class Place extends GObject.Object {
1789
1923
  * @param place_type the type of place
1790
1924
  * @returns a new #GeocodePlace object. Use g_object_unref() when done.
1791
1925
  */
1792
- static new(name: string | null, place_type: PlaceType): Place
1926
+ static new(name: string, place_type: PlaceType): Place
1793
1927
  /**
1794
1928
  * Creates a new #GeocodePlace object.
1795
1929
  * @constructor
@@ -1798,7 +1932,7 @@ export class Place extends GObject.Object {
1798
1932
  * @param location the location info for the place
1799
1933
  * @returns a new #GeocodePlace object. Use g_object_unref() when done.
1800
1934
  */
1801
- static new_with_location(name: string | null, place_type: PlaceType, location: Location): Place
1935
+ static new_with_location(name: string, place_type: PlaceType, location: Location): Place
1802
1936
  _init(config?: Place.ConstructorProperties): void
1803
1937
  }
1804
1938
 
@@ -2063,8 +2197,8 @@ export interface NominatimClass {
2063
2197
  // Own fields of GeocodeGlib-1.0.GeocodeGlib.NominatimClass
2064
2198
 
2065
2199
  parent_class: GObject.ObjectClass
2066
- query: (self: Nominatim, uri: string | null, cancellable: Gio.Cancellable | null) => string | null
2067
- query_async: (self: Nominatim, uri: string | null, cancellable: Gio.Cancellable | null, callback: Gio.AsyncReadyCallback | null) => void
2200
+ query: (self: Nominatim, uri: string, cancellable: Gio.Cancellable | null) => string | null
2201
+ query_async: (self: Nominatim, uri: string, cancellable: Gio.Cancellable | null, callback: Gio.AsyncReadyCallback | null) => void
2068
2202
  query_finish: (self: Nominatim, res: Gio.AsyncResult) => string | null
2069
2203
  }
2070
2204
 
@@ -687,6 +687,16 @@ module Forward {
687
687
  * this area is returned.
688
688
  */
689
689
  search_area?: BoundingBox | null
690
+ /**
691
+ * The number of requested results to a search query.
692
+ */
693
+ answerCount?: number | null
694
+ /**
695
+ * The bounding box that limits the search area.
696
+ * If #GeocodeForward:bounded property is set to #TRUE only results from
697
+ * this area is returned.
698
+ */
699
+ searchArea?: BoundingBox | null
690
700
  }
691
701
 
692
702
  }
@@ -699,6 +709,10 @@ interface Forward {
699
709
  * The number of requested results to a search query.
700
710
  */
701
711
  answer_count: number
712
+ /**
713
+ * The number of requested results to a search query.
714
+ */
715
+ answerCount: number
702
716
  /**
703
717
  * If set to #TRUE then only results in the #GeocodeForward:search-area
704
718
  * bounding box are returned.
@@ -712,6 +726,12 @@ interface Forward {
712
726
  * this area is returned.
713
727
  */
714
728
  search_area: BoundingBox
729
+ /**
730
+ * The bounding box that limits the search area.
731
+ * If #GeocodeForward:bounded property is set to #TRUE only results from
732
+ * this area is returned.
733
+ */
734
+ searchArea: BoundingBox
715
735
 
716
736
  // Owm methods of GeocodeGlib-1.0.GeocodeGlib.Forward
717
737
 
@@ -845,7 +865,7 @@ class Forward extends GObject.Object {
845
865
  * @param str a string containing a free-form description of the location
846
866
  * @returns a new #GeocodeForward. Use g_object_unref() when done.
847
867
  */
848
- static new_for_string(str: string | null): Forward
868
+ static new_for_string(str: string): Forward
849
869
  _init(config?: Forward.ConstructorProperties): void
850
870
  }
851
871
 
@@ -970,7 +990,7 @@ interface Location {
970
990
  * Gets the description of location `loc`.
971
991
  * @returns The description of location @loc.
972
992
  */
973
- get_description(): string | null
993
+ get_description(): string
974
994
  /**
975
995
  * Calculates the distance in km, along the curvature of the Earth,
976
996
  * between 2 locations. Note that altitude changes are not
@@ -999,7 +1019,7 @@ interface Location {
999
1019
  * Sets the description of `loc` to `description`.
1000
1020
  * @param description a description for the location
1001
1021
  */
1002
- set_description(description: string | null): void
1022
+ set_description(description: string): void
1003
1023
  /**
1004
1024
  * Initialize a #GeocodeLocation object with the given `uri`.
1005
1025
  *
@@ -1016,7 +1036,7 @@ interface Location {
1016
1036
  * @param uri a URI mapping out a location
1017
1037
  * @returns %TRUE on success and %FALSE on error.
1018
1038
  */
1019
- set_from_uri(uri: string | null): boolean
1039
+ set_from_uri(uri: string): boolean
1020
1040
  /**
1021
1041
  * Creates a URI representing `loc` in the scheme specified in `scheme`.
1022
1042
  * @param scheme the scheme of the requested URI
@@ -1094,7 +1114,7 @@ class Location extends GObject.Object {
1094
1114
  * @param description a description for the location
1095
1115
  * @returns a new #GeocodeLocation object. Use g_object_unref() when done.
1096
1116
  */
1097
- static new_with_description(latitude: number, longitude: number, accuracy: number, description: string | null): Location
1117
+ static new_with_description(latitude: number, longitude: number, accuracy: number, description: string): Location
1098
1118
  _init(config?: Location.ConstructorProperties): void
1099
1119
  }
1100
1120
 
@@ -1241,6 +1261,31 @@ module Nominatim {
1241
1261
  * string.
1242
1262
  */
1243
1263
  user_agent?: string | null
1264
+ /**
1265
+ * The base URL of the Nominatim service, for example
1266
+ * `https://nominatim.example.org`.
1267
+ */
1268
+ baseUrl?: string | null
1269
+ /**
1270
+ * E-mail address of the maintainer of the software making the
1271
+ * geocoding requests to the Nominatim server. This is used to contact
1272
+ * them in the event of a problem with their usage. See
1273
+ * [the Nominatim API](http://wiki.openstreetmap.org/wiki/Nominatim).
1274
+ */
1275
+ maintainerEmailAddress?: string | null
1276
+ /**
1277
+ * User-Agent string to send with HTTP(S) requests, or %NULL to use the
1278
+ * default user agent, which is derived from the geocode-glib version
1279
+ * and #GApplication:id, for example: `geocode-glib/3.20 (MyAppId)`.
1280
+ *
1281
+ * As per the
1282
+ * [Nominatim usage policy](http://wiki.openstreetmap.org/wiki/Nominatim_usage_policy),
1283
+ * it should be set to a string which identifies the application which
1284
+ * is using geocode-glib, and must be a valid
1285
+ * [user agent](https://tools.ietf.org/html/rfc7231#section-5.5.3)
1286
+ * string.
1287
+ */
1288
+ userAgent?: string | null
1244
1289
  }
1245
1290
 
1246
1291
  }
@@ -1254,6 +1299,11 @@ interface Nominatim extends Backend {
1254
1299
  * `https://nominatim.example.org`.
1255
1300
  */
1256
1301
  readonly base_url: string | null
1302
+ /**
1303
+ * The base URL of the Nominatim service, for example
1304
+ * `https://nominatim.example.org`.
1305
+ */
1306
+ readonly baseUrl: string | null
1257
1307
  /**
1258
1308
  * E-mail address of the maintainer of the software making the
1259
1309
  * geocoding requests to the Nominatim server. This is used to contact
@@ -1261,6 +1311,13 @@ interface Nominatim extends Backend {
1261
1311
  * [the Nominatim API](http://wiki.openstreetmap.org/wiki/Nominatim).
1262
1312
  */
1263
1313
  readonly maintainer_email_address: string | null
1314
+ /**
1315
+ * E-mail address of the maintainer of the software making the
1316
+ * geocoding requests to the Nominatim server. This is used to contact
1317
+ * them in the event of a problem with their usage. See
1318
+ * [the Nominatim API](http://wiki.openstreetmap.org/wiki/Nominatim).
1319
+ */
1320
+ readonly maintainerEmailAddress: string | null
1264
1321
  /**
1265
1322
  * User-Agent string to send with HTTP(S) requests, or %NULL to use the
1266
1323
  * default user agent, which is derived from the geocode-glib version
@@ -1274,6 +1331,19 @@ interface Nominatim extends Backend {
1274
1331
  * string.
1275
1332
  */
1276
1333
  user_agent: string | null
1334
+ /**
1335
+ * User-Agent string to send with HTTP(S) requests, or %NULL to use the
1336
+ * default user agent, which is derived from the geocode-glib version
1337
+ * and #GApplication:id, for example: `geocode-glib/3.20 (MyAppId)`.
1338
+ *
1339
+ * As per the
1340
+ * [Nominatim usage policy](http://wiki.openstreetmap.org/wiki/Nominatim_usage_policy),
1341
+ * it should be set to a string which identifies the application which
1342
+ * is using geocode-glib, and must be a valid
1343
+ * [user agent](https://tools.ietf.org/html/rfc7231#section-5.5.3)
1344
+ * string.
1345
+ */
1346
+ userAgent: string | null
1277
1347
 
1278
1348
  // Own fields of GeocodeGlib-1.0.GeocodeGlib.Nominatim
1279
1349
 
@@ -1281,8 +1351,8 @@ interface Nominatim extends Backend {
1281
1351
 
1282
1352
  // Own virtual methods of GeocodeGlib-1.0.GeocodeGlib.Nominatim
1283
1353
 
1284
- vfunc_query(uri: string | null, cancellable: Gio.Cancellable | null): string | null
1285
- vfunc_query_async(uri: string | null, cancellable: Gio.Cancellable | null, callback: Gio.AsyncReadyCallback<this> | null): void
1354
+ vfunc_query(uri: string, cancellable: Gio.Cancellable | null): string | null
1355
+ vfunc_query_async(uri: string, cancellable: Gio.Cancellable | null, callback: Gio.AsyncReadyCallback<this> | null): void
1286
1356
  vfunc_query_finish(res: Gio.AsyncResult): string | null
1287
1357
 
1288
1358
  // Class property signals of GeocodeGlib-1.0.GeocodeGlib.Nominatim
@@ -1326,7 +1396,7 @@ class Nominatim extends GObject.Object {
1326
1396
  * @param maintainer_email_address the email address of the software maintainer.
1327
1397
  * @returns a new #GeocodeNominatim. Use g_object_unref() when done.
1328
1398
  */
1329
- constructor(base_url: string | null, maintainer_email_address: string | null)
1399
+ constructor(base_url: string, maintainer_email_address: string)
1330
1400
  /**
1331
1401
  * Creates a new backend implementation for an online Nominatim server. See
1332
1402
  * the documentation for #GeocodeNominatim:base-url and
@@ -1336,7 +1406,7 @@ class Nominatim extends GObject.Object {
1336
1406
  * @param maintainer_email_address the email address of the software maintainer.
1337
1407
  * @returns a new #GeocodeNominatim. Use g_object_unref() when done.
1338
1408
  */
1339
- static new(base_url: string | null, maintainer_email_address: string | null): Nominatim
1409
+ static new(base_url: string, maintainer_email_address: string): Nominatim
1340
1410
  _init(config?: Nominatim.ConstructorProperties): void
1341
1411
  /**
1342
1412
  * Gets a reference to the default Nominatim server on nominatim.gnome.org.
@@ -1427,6 +1497,38 @@ module Place {
1427
1497
  * The town.
1428
1498
  */
1429
1499
  town?: string | null
1500
+ /**
1501
+ * The local administrative area.
1502
+ */
1503
+ administrativeArea?: string | null
1504
+ /**
1505
+ * The bounding box for the place.
1506
+ */
1507
+ boundingBox?: BoundingBox | null
1508
+ /**
1509
+ * The country code.
1510
+ */
1511
+ countryCode?: string | null
1512
+ /**
1513
+ * The OpenStreetMap id of the place.
1514
+ */
1515
+ osmId?: string | null
1516
+ /**
1517
+ * The OpenStreetMap type of the place.
1518
+ */
1519
+ osmType?: PlaceOsmType | null
1520
+ /**
1521
+ * The type of the place.
1522
+ */
1523
+ placeType?: PlaceType | null
1524
+ /**
1525
+ * The postal code.
1526
+ */
1527
+ postalCode?: string | null
1528
+ /**
1529
+ * The street address.
1530
+ */
1531
+ streetAddress?: string | null
1430
1532
  }
1431
1533
 
1432
1534
  }
@@ -1439,6 +1541,10 @@ interface Place {
1439
1541
  * The local administrative area.
1440
1542
  */
1441
1543
  administrative_area: string | null
1544
+ /**
1545
+ * The local administrative area.
1546
+ */
1547
+ administrativeArea: string | null
1442
1548
  /**
1443
1549
  * A named area such as a campus or neighborhood.
1444
1550
  */
@@ -1447,6 +1553,10 @@ interface Place {
1447
1553
  * The bounding box for the place.
1448
1554
  */
1449
1555
  bounding_box: BoundingBox
1556
+ /**
1557
+ * The bounding box for the place.
1558
+ */
1559
+ boundingBox: BoundingBox
1450
1560
  /**
1451
1561
  * A specific building on a street or in an area.
1452
1562
  */
@@ -1463,6 +1573,10 @@ interface Place {
1463
1573
  * The country code.
1464
1574
  */
1465
1575
  country_code: string | null
1576
+ /**
1577
+ * The country code.
1578
+ */
1579
+ countryCode: string | null
1466
1580
  /**
1467
1581
  * The county.
1468
1582
  */
@@ -1483,18 +1597,34 @@ interface Place {
1483
1597
  * The OpenStreetMap id of the place.
1484
1598
  */
1485
1599
  osm_id: string | null
1600
+ /**
1601
+ * The OpenStreetMap id of the place.
1602
+ */
1603
+ osmId: string | null
1486
1604
  /**
1487
1605
  * The OpenStreetMap type of the place.
1488
1606
  */
1489
1607
  osm_type: PlaceOsmType
1608
+ /**
1609
+ * The OpenStreetMap type of the place.
1610
+ */
1611
+ osmType: PlaceOsmType
1490
1612
  /**
1491
1613
  * The type of the place.
1492
1614
  */
1493
1615
  readonly place_type: PlaceType
1616
+ /**
1617
+ * The type of the place.
1618
+ */
1619
+ readonly placeType: PlaceType
1494
1620
  /**
1495
1621
  * The postal code.
1496
1622
  */
1497
1623
  postal_code: string | null
1624
+ /**
1625
+ * The postal code.
1626
+ */
1627
+ postalCode: string | null
1498
1628
  /**
1499
1629
  * The state.
1500
1630
  */
@@ -1507,6 +1637,10 @@ interface Place {
1507
1637
  * The street address.
1508
1638
  */
1509
1639
  street_address: string | null
1640
+ /**
1641
+ * The street address.
1642
+ */
1643
+ streetAddress: string | null
1510
1644
  /**
1511
1645
  * The town.
1512
1646
  */
@@ -1530,12 +1664,12 @@ interface Place {
1530
1664
  * Gets the local administrative area of the `place`.
1531
1665
  * @returns The local administrative area of the @place.
1532
1666
  */
1533
- get_administrative_area(): string | null
1667
+ get_administrative_area(): string
1534
1668
  /**
1535
1669
  * Gets the area of the `place`.
1536
1670
  * @returns The area of the @place.
1537
1671
  */
1538
- get_area(): string | null
1672
+ get_area(): string
1539
1673
  /**
1540
1674
  * Gets the bounding box for the place `place`.
1541
1675
  * @returns A #GeocodeBoundingBox, or NULL if boundaries are unknown.
@@ -1545,27 +1679,27 @@ interface Place {
1545
1679
  * Gets the building of the `place`.
1546
1680
  * @returns The building of the @place.
1547
1681
  */
1548
- get_building(): string | null
1682
+ get_building(): string
1549
1683
  /**
1550
1684
  * Gets the continent of the `place`.
1551
1685
  * @returns The continent of the @place.
1552
1686
  */
1553
- get_continent(): string | null
1687
+ get_continent(): string
1554
1688
  /**
1555
1689
  * Gets the country of the `place`.
1556
1690
  * @returns The country of the @place.
1557
1691
  */
1558
- get_country(): string | null
1692
+ get_country(): string
1559
1693
  /**
1560
1694
  * Gets the ISO-3166 country code of the `place`.
1561
1695
  * @returns The ISO-3166 country code of the @place, in upper case.
1562
1696
  */
1563
- get_country_code(): string | null
1697
+ get_country_code(): string
1564
1698
  /**
1565
1699
  * Gets the county of the `place`.
1566
1700
  * @returns The country of the @place.
1567
1701
  */
1568
- get_county(): string | null
1702
+ get_county(): string
1569
1703
  /**
1570
1704
  * Gets the #GIcon representing the `place`.
1571
1705
  * @returns The #GIcon representing the @place.
@@ -1580,12 +1714,12 @@ interface Place {
1580
1714
  * Gets the name of the `place`.
1581
1715
  * @returns The name of the @place.
1582
1716
  */
1583
- get_name(): string | null
1717
+ get_name(): string
1584
1718
  /**
1585
1719
  * Gets the OpenStreetMap ID of the `place`.
1586
1720
  * @returns The osm ID of the @place.
1587
1721
  */
1588
- get_osm_id(): string | null
1722
+ get_osm_id(): string
1589
1723
  /**
1590
1724
  * Gets the OpenStreetMap type of the `place`.
1591
1725
  * @returns The osm type of the @place.
@@ -1600,37 +1734,37 @@ interface Place {
1600
1734
  * Gets the postal code of the `place`.
1601
1735
  * @returns The postal code of the @place.
1602
1736
  */
1603
- get_postal_code(): string | null
1737
+ get_postal_code(): string
1604
1738
  /**
1605
1739
  * Gets the state of the `place`.
1606
1740
  * @returns The state of the @place.
1607
1741
  */
1608
- get_state(): string | null
1742
+ get_state(): string
1609
1743
  /**
1610
1744
  * Gets the street of the `place`.
1611
1745
  * @returns The street of the @place.
1612
1746
  */
1613
- get_street(): string | null
1747
+ get_street(): string
1614
1748
  /**
1615
1749
  * Gets the street address of the `place`.
1616
1750
  * @returns The street address of the @place.
1617
1751
  */
1618
- get_street_address(): string | null
1752
+ get_street_address(): string
1619
1753
  /**
1620
1754
  * Gets the town of the `place`.
1621
1755
  * @returns The town of the @place.
1622
1756
  */
1623
- get_town(): string | null
1757
+ get_town(): string
1624
1758
  /**
1625
1759
  * Sets the local administrative area of `place` to `admin_area`.
1626
1760
  * @param admin_area an administrative area for the place
1627
1761
  */
1628
- set_administrative_area(admin_area: string | null): void
1762
+ set_administrative_area(admin_area: string): void
1629
1763
  /**
1630
1764
  * Sets the area of `place` to `area`.
1631
1765
  * @param area a area
1632
1766
  */
1633
- set_area(area: string | null): void
1767
+ set_area(area: string): void
1634
1768
  /**
1635
1769
  * Sets the #GeocodeBoundingBox for the place `place`.
1636
1770
  * @param bbox A #GeocodeBoundingBox for the place
@@ -1640,27 +1774,27 @@ interface Place {
1640
1774
  * Sets the building of `place` to `building`.
1641
1775
  * @param building a building
1642
1776
  */
1643
- set_building(building: string | null): void
1777
+ set_building(building: string): void
1644
1778
  /**
1645
1779
  * Sets the continent of `place` to `continent`.
1646
1780
  * @param continent a continent for the place
1647
1781
  */
1648
- set_continent(continent: string | null): void
1782
+ set_continent(continent: string): void
1649
1783
  /**
1650
1784
  * Sets the country of `place` to `country`.
1651
1785
  * @param country a country for the place
1652
1786
  */
1653
- set_country(country: string | null): void
1787
+ set_country(country: string): void
1654
1788
  /**
1655
1789
  * Sets the ISO country code of `place` to `country_code`.
1656
1790
  * @param country_code an ISO country code for the place
1657
1791
  */
1658
- set_country_code(country_code: string | null): void
1792
+ set_country_code(country_code: string): void
1659
1793
  /**
1660
1794
  * Sets the county of `place` to `county`.
1661
1795
  * @param county a county for the place
1662
1796
  */
1663
- set_county(county: string | null): void
1797
+ set_county(county: string): void
1664
1798
  /**
1665
1799
  * Sets the location of `place` to `location`.
1666
1800
  * @param location A location
@@ -1670,32 +1804,32 @@ interface Place {
1670
1804
  * Sets the name of the `place` to `name`.
1671
1805
  * @param name the name of place
1672
1806
  */
1673
- set_name(name: string | null): void
1807
+ set_name(name: string): void
1674
1808
  /**
1675
1809
  * Sets the postal code of `place` to `postal_code`.
1676
1810
  * @param postal_code a postal code for the place
1677
1811
  */
1678
- set_postal_code(postal_code: string | null): void
1812
+ set_postal_code(postal_code: string): void
1679
1813
  /**
1680
1814
  * Sets the state of `place` to `state`.
1681
1815
  * @param state a state for the place
1682
1816
  */
1683
- set_state(state: string | null): void
1817
+ set_state(state: string): void
1684
1818
  /**
1685
1819
  * Sets the street of `place` to `street`.
1686
1820
  * @param street a street
1687
1821
  */
1688
- set_street(street: string | null): void
1822
+ set_street(street: string): void
1689
1823
  /**
1690
1824
  * Sets the street address of `place` to `street_address`.
1691
1825
  * @param street_address a street address for the place
1692
1826
  */
1693
- set_street_address(street_address: string | null): void
1827
+ set_street_address(street_address: string): void
1694
1828
  /**
1695
1829
  * Sets the town of `place` to `town`.
1696
1830
  * @param town a town for the place
1697
1831
  */
1698
- set_town(town: string | null): void
1832
+ set_town(town: string): void
1699
1833
 
1700
1834
  // Class property signals of GeocodeGlib-1.0.GeocodeGlib.Place
1701
1835
 
@@ -1783,7 +1917,7 @@ class Place extends GObject.Object {
1783
1917
  * @param place_type the type of place
1784
1918
  * @returns a new #GeocodePlace object. Use g_object_unref() when done.
1785
1919
  */
1786
- constructor(name: string | null, place_type: PlaceType)
1920
+ constructor(name: string, place_type: PlaceType)
1787
1921
  /**
1788
1922
  * Creates a new #GeocodePlace object.
1789
1923
  * @constructor
@@ -1791,7 +1925,7 @@ class Place extends GObject.Object {
1791
1925
  * @param place_type the type of place
1792
1926
  * @returns a new #GeocodePlace object. Use g_object_unref() when done.
1793
1927
  */
1794
- static new(name: string | null, place_type: PlaceType): Place
1928
+ static new(name: string, place_type: PlaceType): Place
1795
1929
  /**
1796
1930
  * Creates a new #GeocodePlace object.
1797
1931
  * @constructor
@@ -1800,7 +1934,7 @@ class Place extends GObject.Object {
1800
1934
  * @param location the location info for the place
1801
1935
  * @returns a new #GeocodePlace object. Use g_object_unref() when done.
1802
1936
  */
1803
- static new_with_location(name: string | null, place_type: PlaceType, location: Location): Place
1937
+ static new_with_location(name: string, place_type: PlaceType, location: Location): Place
1804
1938
  _init(config?: Place.ConstructorProperties): void
1805
1939
  }
1806
1940
 
@@ -2065,8 +2199,8 @@ interface NominatimClass {
2065
2199
  // Own fields of GeocodeGlib-1.0.GeocodeGlib.NominatimClass
2066
2200
 
2067
2201
  parent_class: GObject.ObjectClass
2068
- query: (self: Nominatim, uri: string | null, cancellable: Gio.Cancellable | null) => string | null
2069
- query_async: (self: Nominatim, uri: string | null, cancellable: Gio.Cancellable | null, callback: Gio.AsyncReadyCallback | null) => void
2202
+ query: (self: Nominatim, uri: string, cancellable: Gio.Cancellable | null) => string | null
2203
+ query_async: (self: Nominatim, uri: string, cancellable: Gio.Cancellable | null, callback: Gio.AsyncReadyCallback | null) => void
2070
2204
  query_finish: (self: Nominatim, res: Gio.AsyncResult) => string | null
2071
2205
  }
2072
2206
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@girs/geocodeglib-1.0",
3
- "version": "1.0.0-3.2.5",
3
+ "version": "1.0.0-3.2.7",
4
4
  "description": "GJS TypeScript type definitions for GeocodeGlib-1.0, generated from library version 1.0.0",
5
5
  "type": "module",
6
6
  "module": "geocodeglib-1.0.js",
@@ -25,12 +25,12 @@
25
25
  "test:cjs": "NODE_OPTIONS=--max_old_space_size=9216 tsc --noEmit geocodeglib-1.0.d.cts"
26
26
  },
27
27
  "dependencies": {
28
- "@girs/gio-2.0": "^2.78.0-3.2.5",
29
- "@girs/gjs": "^3.2.5",
30
- "@girs/glib-2.0": "^2.78.0-3.2.5",
31
- "@girs/gobject-2.0": "^2.78.0-3.2.5",
32
- "@girs/json-1.0": "^1.7.1-3.2.5",
33
- "@girs/soup-2.4": "^2.74.3-3.2.5"
28
+ "@girs/gio-2.0": "^2.78.0-3.2.7",
29
+ "@girs/gjs": "^3.2.7",
30
+ "@girs/glib-2.0": "^2.78.0-3.2.7",
31
+ "@girs/gobject-2.0": "^2.78.0-3.2.7",
32
+ "@girs/json-1.0": "^1.7.1-3.2.7",
33
+ "@girs/soup-2.4": "^2.74.3-3.2.7"
34
34
  },
35
35
  "devDependencies": {
36
36
  "typescript": "*"